diff --git a/.gitignore b/.gitignore index dbbe711..a805bf9 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ __pycache__ build/ dist/ *.egg-info +*.token diff --git a/setup.py b/setup.py index 05a917d..10ebb23 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ with open("README.md", "r") as fh: long_description = fh.read() setuptools.setup( - name="bits", + name="binary-bits", version="1.0.0", author="S Groesz", description="Provide additional methods for working with binary data", diff --git a/src/bits.py b/src/bits.py index f81cb76..8dd0312 100644 --- a/src/bits.py +++ b/src/bits.py @@ -1,7 +1,24 @@ class Bit: """ - Provide a flexible bit representation + Provide a flexible bit representation. + + Extended description of function. + + Parameters + ---------- + var : bool | int | str | Bit + Any of the supported objects which can be converted to a Bit object. + bool: True or False + int: 0 = False, anything else = True + str: "0" = False, anything else = True + BIT: Bit = Bit + + Returns + ------- + Bit + A binary representation of True or False with additional useful + features. """ def __init__(self, var):