Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (52 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 1.19 KB

Contributing

Go for it.

Updating the PYPI package

1. Update the version number in setup.cfg

Increment version under metadata in setup.cfg.

Use semantic versioning. See https://semver.org/

2. Install the package locally

Use your favored environment manager.

pip install -e .[dev]

3. Rerun tests if necessary

pytest

4. Check/update MANIFEST.in

Will also check the package configuration.

check-manifest -u

5. Build the package

python -m build

6. Check the README

twine check dist/*

7. Have a PyPI account

If needed, create an account on https://pypi.org/ with an accessible password.

8. Optionally, run against test.pypi.org

Note that https://test.pypi.org requires a separate account registration.

twine upload --repository testpypi dist/*

And try installing it with,

pip uninstall -y prompt-hyperopt
pip install --index-url https://test.pypi.org/simple/ prompt-hyperopt
python -m prompt-hyperopt

9. Upload the package

twine upload dist/* --verbose

10. Use the package

pip install --upgrade prompt-hyperopt
python -m prompt-hyperopt