Contribute
Development installation
If you want to contribute to Pyfood, you will need to install the test dependencies. You can do so with
$ pip install pyfood[tests,examples]
$ pytest tests/
Uploading the distribution archives
Clone pyfood from the source code
Create a Python 3.6+ virtual environment
Install requirements
$ git clone https://github.com/MichelDeudon/pyfood.git
$ pip install requirements.txt
$ python -m pip install --user --upgrade setuptools wheel
$ python setup.py sdist bdist_wheel
This command should output a lot of text and once completed should generate two files in the dist/
directory:
pyfood-x.x.x-py3-none-any.whl
and pyfood-x.x.x.tar.gz
Install Twine to upload the distribution packages
Upload all of the archives under dist/
$ python -m pip install --user --upgrade twine
$ python -m twine upload -u __token__ -p pypi-API-token --repository testpypi dist/* --verbose
Once uploaded your package should be viewable on TestPyPI. You can use pip to install your package and verify that it works.
$ python -m pip install --index-url https://test.pypi.org/simple/ --no-deps pyfood
You can test that it was installed correctly by importing the package.
import pyfood
Use twine upload dist/* to upload your package and enter your credentials for the account you registered on the real PyPI. Now that you’re uploading the package in production, you don’t need to specify –repository; the package will upload to https://pypi.org by default.
Install your package from the real PyPI using
$ pip install pyfood
Build documentation
$ make clean
$ sphinx-build -b html . build