update for pypi
This commit is contained in:
parent
1533f7ade6
commit
3ad4435b3f
|
@ -4,3 +4,4 @@ __pycache__
|
||||||
build/
|
build/
|
||||||
dist/
|
dist/
|
||||||
*.egg-info
|
*.egg-info
|
||||||
|
*.token
|
||||||
|
|
2
setup.py
2
setup.py
|
@ -4,7 +4,7 @@ with open("README.md", "r") as fh:
|
||||||
long_description = fh.read()
|
long_description = fh.read()
|
||||||
|
|
||||||
setuptools.setup(
|
setuptools.setup(
|
||||||
name="bits",
|
name="binary-bits",
|
||||||
version="1.0.0",
|
version="1.0.0",
|
||||||
author="S Groesz",
|
author="S Groesz",
|
||||||
description="Provide additional methods for working with binary data",
|
description="Provide additional methods for working with binary data",
|
||||||
|
|
19
src/bits.py
19
src/bits.py
|
@ -1,7 +1,24 @@
|
||||||
|
|
||||||
class Bit:
|
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):
|
def __init__(self, var):
|
||||||
|
|
Loading…
Reference in New Issue