summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAssaf Gordon <assafgordon@gmail.com>2016-05-12 05:44:58 (GMT)
committerAssaf Gordon <assafgordon@gmail.com>2016-05-12 05:44:58 (GMT)
commite31c5aa52fbb4eb7cd46831ee515a3c2b190afad (patch)
treea1eecc376e53f9bfa9ea9a0d80cfd08c91c11734
parent9820ac8966d239d52b94a3edacbcd99418f10d7b (diff)
downloadcgi-tools-e31c5aa52fbb4eb7cd46831ee515a3c2b190afad.zip
cgi-tools-e31c5aa52fbb4eb7cd46831ee515a3c2b190afad.tar.gz
cgi-tools-e31c5aa52fbb4eb7cd46831ee515a3c2b190afad.tar.bz2
doc: add HACKING.md
-rw-r--r--HACKING.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..6953273
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,69 @@
+
+Registering a new package
+-------------------------
+
+See fantastic tutorial at: http://peterdowns.com/posts/first-time-with-pypi.html
+
+prepare PyPi config file (with updated passwords):
+
+ $ cat ~/.pypirc
+ [distutils]
+ index-servers =
+ pypi
+ pypitest
+
+ [pypi]
+ repository=https://pypi.python.org/pypi
+ username=agn
+ password=xxx
+
+ [pypitest]
+ repository=https://testpypi.python.org/pypi
+ username=agn
+ password=xxx
+
+Register on PyPiTest first:
+
+ python setup.py register -r pypitest
+
+If all went well, register on PyPi:
+
+ python setup.py register -r pypi
+
+Making a new release
+--------------------
+
+1. Tag a new version. Uploading to PyPi requires
+ a clean public version, without a private version part
+ (see PEP-440 for details).
+ So `0.0.4` is OK, while `0.0.4-7-gab12-dirty` will be rejected
+ by PyPi.
+
+ git tag -a "0.0.2" -m "version 0.0.2"
+
+ Ensure the new version is properly detected and used:
+
+ $ ./detect_version.py cgi_tools
+ 0.0.2
+
+2. Test upload to PyPiTest:
+
+ $ python setup.py sdist upload -r pypitest
+ [...]
+ Writing cgi-tools-0.0.2/setup.cfg
+ Creating tar archive
+ removing 'cgi-tools-0.0.2' (and everything under it)
+ running upload
+ Submitting dist/cgi-tools-0.0.2.tar.gz to https://pypi.python.org/pypitest
+ Server response (200): OK
+
+3. If upload went well, upload to PyPi
+
+ python setup.py sdist upload -r pypi
+
+4. Push changes to github, including tags (if your remote is `origin`,
+ replace `github` below):
+
+ git push github master
+ git push github --tags
+