update for pypi

This commit is contained in:
S Groesz 2020-11-19 04:23:42 +00:00
parent 1533f7ade6
commit 3ad4435b3f
3 changed files with 20 additions and 2 deletions

1
.gitignore vendored
View File

@ -4,3 +4,4 @@ __pycache__
build/
dist/
*.egg-info
*.token

View File

@ -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",

View File

@ -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):