feat: Package as Python library (#29)

* Add BSD3 LICENSE
* Package as Python library with src/ directory structure
   - Uses setup.py, setup.cfg, and pyproject.toml
* Preserve global script style of installation through symlinking module files to top level of repository
* Add linting and packaging check GitHub Actions worfklows
* Add version updating through bumpversion
* Update installation and use instructions

.bumpversion.cfg

@@ -0,0 +1,8 @@
+[bumpversion]
+current_version = 0.1.0
+commit = True
+tag = True
+
+[bumpversion:file:setup.cfg]
+
+[bumpversion:file:src/pandamonium/version.py]

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+ pull_request:
+
+jobs:
+ lint:
+
+ name: Lint Codebase
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python 3.8
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.8
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip setuptools wheel
+ python -m pip install --upgrade -q --no-cache-dir --use-feature=2020-resolver -e .[lint]
+ python -m pip list
+ - name: Lint with Pyflakes
+ run: |
+ python -m pyflakes .
+ - name: Lint with Black
+ run: |
+ black --check --diff --verbose .

.github/workflows/publish-package.yml

@@ -0,0 +1,68 @@
+name: publish distributions
+on:
+ push:
+ branches:
+ - master
+ tags:
+ - v*
+ pull_request:
+ branches:
+ - master
+
+jobs:
+ build-and-publish:
+ name: Build and publish Python distro to (Test)PyPI
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
+ - name: Set up Python 3.8
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.8
+ - name: Install pep517, check-manifest, and twine
+ run: |
+ python -m pip install --upgrade pip setuptools wheel
+ python -m pip install pep517 --user
+ python -m pip install check-manifest twine
+ - name: Check MANIFEST
+ run: |
+ check-manifest
+ - name: Test the build backend is compliant with PEP517
+ run: |
+ python -m pep517.check .
+ - name: Build a wheel and a sdist
+ run: |
+ python -m pep517.build --source --binary --out-dir dist/ .
+ - name: Verify untagged commits have dev versions
+ if: "!startsWith(github.ref, 'refs/tags/')"
+ run: |
+ latest_tag=$(git describe --tags)
+ latest_tag_revlist_SHA=$(git rev-list -n 1 ${latest_tag})
+ master_SHA="$(git rev-parse --verify origin/master)"
+ wheel_name=$(find dist/ -iname "*.whl" -printf "%f\n")
+ if [[ "${latest_tag_revlist_SHA}" != "${master_SHA}" ]]; then # don't check master push events coming from tags
+ if [[ "${wheel_name}" == *"pandamonium-0.1.dev"* || "${wheel_name}" != *"dev"* ]]; then
+ echo "pep517.build incorrectly named built distribution: ${wheel_name}"
+ echo "pep517 is lacking the history and tags required to determine version number"
+ echo "intentionally erroring with 'return 1' now"
+ return 1
+ fi
+ else
+ echo "Push event to origin/master was triggered by push of tag ${latest_tag}"
+ fi
+ echo "pep517.build named built distribution: ${wheel_name}"
+ - name: Verify tagged commits don't have dev versions
+ if: startsWith(github.ref, 'refs/tags')
+ run: |
+ wheel_name=$(find dist/ -iname "*.whl" -printf "%f\n")
+ if [[ "${wheel_name}" == *"dev"* ]]; then
+ echo "pep517.build incorrectly named built distribution: ${wheel_name}"
+ echo "this is incorrrectly being treated as a dev release"
+ echo "intentionally erroring with 'return 1' now"
+ return 1
+ fi
+ echo "pep517.build named built distribution: ${wheel_name}"
+ - name: Verify the distribution
+ run: twine check dist/*

.gitignore

@@ -1 +1,129 @@
-*.txt
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.pre-commit-config.yaml

@@ -4,4 +4,3 @@ repos:
  hooks:
  - id: black
  language_version: python3
- files: panda\.*

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2016, Daniel Guest
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,5 @@
+graft src
+
+include LICENSE
+
+global-exclude __pycache__ *.py[cod]