Python library that serves as an example/template for a package publishing guide.
This library is an illustration of the various tasks and components involved in the process of publishing a small open-source Python package on PyPI, including establishment of linting standards, implementation of unit tests, measurement of coverage, and basic continuous integration.
The package is available on PyPI:
python -m pip install published
The library can be imported in the usual ways:
import published from published import published
All unit tests are executed and their coverage is measured when using nose (see setup.cfg for configuration details):
nosetests
Alternatively, the unit tests that are included in the module itself can be executed using doctest:
python published/published.py -v
Style conventions are enforced using Pylint:
pylint published
In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.
The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.