Add release instructions

CartoDB · Jun 16, 2023 · 85b9a75 · 85b9a75
1 parent dbe458a
commit 85b9a75
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -27,7 +27,7 @@ docs:
 publish-pypi:
 	rm -rf $(DIST) $(BUILD) *.egg-info
 	$(BIN)/python setup.py sdist bdist_wheel
-	$(BIN)/twine upload $(DIST)/*
+	$(BIN)/twine upload --repository carto-auth $(DIST)/*
 
 publish-test-pypi:
 	rm -rf $(DIST) $(BUILD) *.egg-info

diff --git a/README.md b/README.md
@@ -65,4 +65,20 @@ Check the development [documentation](./docs) section.
 ## Contributors
 
 - [Jesús Arroyo](https://github.com/jesus89)
+- [Valentin de la Cruz](https://github.com/vdelacruzb)
 - [Óscar Ramírez](https://github.com/tuxskar)
+
+## Release
+
+The release to PyPI requires an API token and setting the following file locally with the token: `~/.pypirc`
+
+```
+[distutils]
+index-servers =
+    carto-auth
+
+[carto-auth]
+repository = https://upload.pypi.org/legacy/
+username = __token__
+password = <PyPI token>
+```