diff --git a/CHANGELOG b/CHANGELOG index 12a7bba..e837879 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,6 @@ +25.1.0 + * Explain publishing steps in README + 25.0.0 * Clean up literal_eval of DeprecationWarnings. * Use --no-renames for path detection in layer-update diff --git a/README.md b/README.md index 1204ab8..ca8722f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,21 @@ Viktor Dick git clone https://github.com/perfact/zodbsync.git +## Building and publishing +In general, the PyPi access token is personalized, so publishing can only be +done by one person (currently Viktor). Scratch tokens are stored in the PerFact +vault so this can be changed in the case of an emergency. + +See https://packaging.python.org/en/latest/tutorials/packaging-projects/. + +The username `__token__` and the password from pypi needs to be stored to +`~/.pypirc`. Then: + + virtualenv venv + venv/bin/pip install build twine + venv/bin/python -m build + venv/bin/twine upload dist/* + ## Installation The package should be installed using `pip` in the same virt-env as `zope`, p.e.