If you find errors, omissions, inconsistencies or other things that need improvement, please create an issue or a pull request at http://github.com/sfstoolbox/sfs-python/. Contributions are always welcome!
Instead of pip-installing the latest release from PyPI, you should get the newest development version from Github:
git clone https://github.com/sfstoolbox/sfs-python.git cd sfs-python python setup.py develop --user
This way, your installation always stays up-to-date, even if you pull new changes from the Github repository.
If you prefer, you can also replace the last command with:
pip install --user -e .
... where -e stands for --editable.
If you make changes to the documentation, you can re-create the HTML pages using Sphinx. You can install it and a few other necessary packages with:
pip install -r doc/requirements.txt --user
To create the HTML pages, use:
python setup.py build_sphinx
The generated files will be available in the directory build/sphinx/html/.
New releases are made using the following steps:
- Bump version number in
sfs/__init__.py - Update
NEWS.rst - Commit those changes as "Release x.y.z"
- Create an (annotated) tag with
git tag -a x.y.z - Clear the
dist/directory - Create a source distribution with
python3 setup.py sdist - Create a wheel distribution with
python3 setup.py bdist_wheel --universal - Check that both files have the correct content
- Upload them to PyPI with twine:
twine upload dist/* - Push the commit and the tag to Github and add release notes containing a
link to PyPI and the bullet points from
NEWS.rst - Check that the new release was built correctly on RTD, delete the "stable" version and select the new release as default version