updated REAME

Author: FrancescoSaverioZuppichini

.github/workflows/publish.yml

@@ -27,12 +27,8 @@ jobs:
           pip install ".[dev]"
       - name: 🚀 Publish to PyPi
         env: 
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-          TWINE_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
+          PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+          PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
 
-        run: |
-          python setup.py sdist bdist_wheel
-          twine upload -r testpypi dist/* -u $TWINE_USERNAME -p $TWINE_TEST_PASSWORD --verbose 
-          twine check dist/*
-          twine upload dist/* -u $TWINE_USERNAME -p $TWINE_PASSWORD --verbose 
+        run: make publish

Makefile

@@ -14,4 +14,9 @@ check_code_quality:
 	flake8 $(check_dirs) --count --select=E9,F63,F7,F82 --show-source --statistics
 	# exit-zero treats all errors as warnings. E203 for black, E501 for docstring, W503 for line breaks before logical operators 
 	flake8 $(check_dirs) --count --max-line-length=88 --exit-zero  --ignore=D --extend-ignore=E203,E501,W503  --statistics
-	
+	
+publish:
+	python setup.py sdist bdist_wheel
+	twine upload -r testpypi dist/* -u ${PYPI_USERNAME} -p ${PYPI_TEST_PASSWORD} --verbose 
+	twine check dist/*
+	twine upload dist/* -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --verbose 

README.md

@@ -47,15 +47,44 @@ So far, **there is no types checking with mypy**. See [issue](https://github.com
 
 [`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests.
 
-### CI/CD
+### Publish on PyPi 🚀
+
+**Important**: Before publishing, edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
+
+We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier. You can publish by using
+
+```
+export PYPI_USERNAME="you_username"
+export PYPI_PASSWORD="your_password"
+export PYPI_TEST_PASSWORD="your_password_for_test_pypi"
+make publish
+```
+
+You can also use token for auth, see [pypi doc](https://pypi.org/help/#apitoken). In that case,
+
+```
+export PYPI_USERNAME="__token__"
+export PYPI_PASSWORD="your_token"
+export PYPI_TEST_PASSWORD="your_token_for_test_pypi"
+make publish
+```
+
+**Note**: We will try to push to [test pypi](https://test.pypi.org/) before pushing to pypi, to assert everything will work
+
+### CI/CD 🤖
 
 We use [GitHub actions](https://github.com/features/actions) to automatically run tests and check code quality when a new PR is done on `main`.
 
 On any pull request, we will check the code quality and tests.
 
-#### Publish on PyPi
+When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier. 
+
+The **correct steps** to create a new realease are the following:
+- edit `__version__` in [src/__init__](/src/__init__.py) to match the wanted new version.
+- create a new [`tag`](https://git-scm.com/docs/git-tag) with the release name, e.g. `git tag v0.0.1 && git push origin v0.0.1` or from the GitHub UI.
+- create a new release from GitHub UI
 
-When a new release is created, we will try to push the new code to PyPi. We use [`twine`](https://twine.readthedocs.io/en/stable/) to make our life easier.
+The CI will run when you create the new release.
 
 # Q&A