import-ready

This repository demonstrates steps needed to publish an importable Python package first to TestPyPI, and second to PyPI. If this demonstration deviates from best practice in any way, please submit an issue on GitHub.

Inside import-ready is a package called huntsville_havoc that divulges a couple of bona fide secrets that most diehard SPHL Huntsville Havoc fans don't know.

Prepare the Package

1. Prepare your environment before installing Python packages.
2. Update version in setup.py per semantic versioning guidance.

Test in Development Environment

Run as follows from the top level directory in a clean venv with pip-tools installed:

python -m piptools compile --generate-hashes --allow-unsafe dev-requirements.in
dos2unix dev-requirements.txt
python -m pip install -r dev-requirements.txt
python -m pytest -s tests

Publish to TestPyPI

1. Git commit, tag, & push all desired edits for release.
2. Create a new release in GitHub to mirror your new version.
3. Generate distribution archives for your package.
4. Upload your package to TestPyPI.

Test the TestPyPI Published Package

Run as follows from some random directory (to prove to yourself you're not "cheating" with some locally obtained import-ready) in another clean venv with pip-tools installed:

cp <path to import-ready>/tests/origins_test.py .
cp <path to import-ready>/tests/pubtest-requirements.in .
python -m piptools compile --generate-hashes pubtest-requirements.in
dos2unix pubtest-requirements.txt
python -m pip install -r pubtest-requirements.txt
python -m pytest -s

Publish to PyPI

After completing the above steps, upload your package to PyPI.

Test the real deal

Post-publish test, importing import-ready itself back from PyPI. Run as follows from some other random directory (same reason as for TestPyPI testing above) in yet another clean venv with pip-tools installed:

cp <path to import-ready>/tests/origins_test.py .
cp <path to import-ready>/tests/pub-requirements.in .
python -m piptools compile --generate-hashes pub-requirements.in
dos2unix pub-requirements.txt
python -m pip install -r pub-requirements.txt
python -m pytest -s

Thanks

License

MIT.