From e94a824fa06449b3fa2fc100e53ea2e7e2892daa Mon Sep 17 00:00:00 2001 From: S Groesz Date: Wed, 28 Oct 2020 03:20:38 +0000 Subject: [PATCH] refactor code structure. tests passing. --- Makefile | 8 ++++---- README.md | 7 +++++++ bits/main.py => bits.py | 0 bits/__init__.py | 1 - docs/Makefile | 5 +++++ setup.py | 2 +- 6 files changed, 17 insertions(+), 6 deletions(-) rename bits/main.py => bits.py (100%) delete mode 100644 bits/__init__.py create mode 100644 docs/Makefile diff --git a/Makefile b/Makefile index 5340086..425653f 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,10 @@ init: - pip install -r requirements.txt + pip3 install --user -r requirements.txt test: - python -m unittest -v tests/test_bit.py - python -m unittest -v tests/test_bits.py - python -m unittest -v tests/test_bytes.py + python3 -m unittest -v tests/test_bit.py + python3 -m unittest -v tests/test_bits.py + python3 -m unittest -v tests/test_bytes.py .PHONY: init test diff --git a/README.md b/README.md index dfb57dd..6cef4a1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # Bits Helps manage your bits! + +Intended to be compatible with Python 3.6+. Written and tested against Python +3.8.5 Ubuntu 20.04.1 LTS. + +If something doesn't work in Python 3.6, it's a bug. Please report any such +bugs if they are encountered. + diff --git a/bits/main.py b/bits.py similarity index 100% rename from bits/main.py rename to bits.py diff --git a/bits/__init__.py b/bits/__init__.py deleted file mode 100644 index d936eba..0000000 --- a/bits/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .main import Bit, Bits, Bytes diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..72cc9aa --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,5 @@ +# Makefile for Sphinx documentation +# +# This is currently a stub. TODO: documentation +# + diff --git a/setup.py b/setup.py index 1f15621..83bfd70 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open("README.md", "r") as fh: setuptools.setup( name="bits", - version="1.0.1", + version="1.0.0", author="S Groesz", description="Make your bits easier to handle", long_description=long_description,