Quick reference for publishing to PyPI (#19)

This PR adds a reference for publishing to PyPI.
dmitryduev · Jul 24, 2022 · f9651e3 · f9651e3
1 parent a62fd3b
commit f9651e3
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/penquins/penquins.py b/penquins/penquins.py
@@ -18,7 +18,7 @@
 from typing import Mapping, Optional, Sequence, Union
 
 
-__version__ = "2.1.0"
+__version__ = "2.2.0"
 
 
 Num = Union[int, float]

diff --git a/readme.md b/readme.md
@@ -237,3 +237,22 @@ response = kowalski.api(method="post", endpoint="/api/users", data=request)
 
 response = kowalski.api(method="delete", endpoint=f"/api/users/{username}")
 ```
+
+## Publish new version
+
+Please refer to https://realpython.com/pypi-publish-python-package/
+for a detailed guide.
+
+```shell script
+pip install bumpversion
+export PENQUINS_VERSION=2.2.0
+
+bumpversion --current-version $PENQUINS_VERSION minor setup.py penquins/penquins.py
+python setup.py sdist bdist_wheel
+
+twine check dist/*$PENQUINS_VERSION*
+twine upload dist/*$PENQUINS_VERSION*
+
+username: __token__
+token: <TOKEN>
+```
diff --git a/setup.py b/setup.py
@@ -134,7 +134,7 @@ def run_git(cmd):
 URL = "https://github.com/dmitryduev/penquins"
 
 # VERSION should be PEP386 compatible (http://www.python.org/dev/peps/pep-0386)
-VERSION = "2.1.0"
+VERSION = "2.2.0"
 
 # Indicates if this version is a release version
 RELEASE = "dev" not in VERSION