Developers¶
Documentation for developers for maintaining and extending.
Distribtuion¶
Uploading package to PyPi using twine. Remember to remove all Eggs before doing a push to PyPi.
1 2 | sudo python3 setup.py bdist_wheel
twine upload dist/*
|
To install package systemwide set the prefix value when running setuptools:
1 | sudo python3 setup.py install --prefix=/usr
|
1 | sudo python3 -m pip install --upgrade .
|
Unit testing overview: http://docs.python-guide.org/en/latest/writing/tests/
Documentation¶
If you want to generate the docs make sure the Napoleon package is installed:
1 | pip install sphinxcontrib-napoleon
|
Coding standards for parsing the correct docs is given in:
- https://sphinxcontrib-napoleon.readthedocs.io/en/latest/
- https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
Introduction to Python Virtual Enviroments:
Mixins¶
The following are useful links to some of the mixin implementations used in the SPiRA framework,