add usage to package docstring; fixes #83

This commit is contained in:
Andreas van Cranenburgh 2019-05-03 21:19:16 +02:00 committed by Ram Rachum
parent 750ef4c639
commit 7e845b8f49

View file

@ -1,5 +1,20 @@
# Copyright 2019 Ram Rachum and collaborators.
# This program is distributed under the MIT license.
"""PySnooper - Never use print for debugging again
Usage:
import pysnooper
@pysnooper.snoop()
def number_to_bits(number):
...
A log will be written to stderr showing the lines executed and variables
changed in the decorated function.
For more information, see https://github.com/cool-RR/PySnooper
"""
from .pysnooper import snoop
from .variables import Attrs, Exploding, Indices, Keys