truckle 0.1.4

A simple setuptools alternative for packing Python modules (with or without FFI bindings) into wheels.

A simple setuptools alternative for packing Python modules (with or without FFI bindings) into wheels.

Installation and Usage

This library is available as a package on PyPI:

python -m pip install truckle

The library can be imported in the usual way:

from truckle import truckle

Examples

The function truckle can be used as follows:

>>> path_to_wheel = truckle.truckle("/Documents/GitHub/mclbn256/pyproject.toml")
`mclbn256` v0.3.5 wheel built at /home/Documents/GitHub/mclbn256/mclbn256-0.3.5-cp39-abi3-macosx_12_0_arm64.whl
>>> path_to_wheel
'/home/Documents/GitHub/mclbn256/mclbn256-0.3.5-cp39-abi3-macosx_12_0_arm64.whl'

Development

All installation and development dependencies are fully specified in pyproject.toml. The project.optional-dependencies object is used to specify optional requirements for various development tasks. This makes it possible to specify additional options (such as docs, lint, and so on) when performing installation using pip:

python -m pip install .[docs,lint]

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install .[test]
python -m pytest

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python src/truckle/truckle.py -v

Style conventions are enforced using Pylint:

python -m pip install .[lint]
python -m pylint src/truckle

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

Beginning with version 0.1.0, 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.

Publishing

This library can be published as a package on PyPI by a package maintainer. First, install the dependencies required for packaging and publishing:

python -m pip install .[publish]

Ensure that the correct version number appears in the pyproject.toml file and in any links to this package’s Read the Docs documentation that exist in this README document. Also ensure that the Read the Docs project for this library has an automation rule that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ?.?.? with the version number):

git tag ?.?.?
git push origin ?.?.?

Remove any old build/distribution files. Then, package the source into a distribution archive using the wheel package:

rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .

Finally, upload the package distribution archive to PyPI using the twine package:

python -m twine upload dist/*