Browse Source

[docs] How to release the pypi package

Romain Rigaux 4 years ago
parent
commit
23ea7b3dad

+ 1 - 1
docs/docs-site/content/developer/api/cli/_index.md

@@ -25,7 +25,7 @@ And use:
 
     > compose query
 
-    > compose query autocomplete
+  > compose query autocomplete
 
 List, view, download, upload files:
 

+ 18 - 1
docs/docs-site/content/developer/development/_index.md

@@ -796,7 +796,24 @@ Then connect to the server and index the package:
 
 ### Pypi
 
-TBD
+The Python API and CLI (and soon API) are being transitioned to https://github.com/gethue/compose which host the `compose` and `compose-admin` commands.
+
+How to update the repo https://pypi.org/project/gethue/:
+
+    rm -rf dist && python3 -m build && python3 -m twine upload dist/*
+
+    python3 -m pip install gethue --upgrade
+
+Note:
+
+A Pypi token will be needed. For doing a test release https://test.pypi.org/project/gethue/ is handy:
+
+    python3 -m pip install --upgrade build
+
+    rm -rf dist && python3 -m build && python3 -m twine upload --repository testpypi dist/*
+    python3 -m pip install --index-url https://test.pypi.org/simple/ gethue --upgrade
+
+Read more on [Python packaging](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives).
 
 ### Documentation