From cd0ad417436a0f3ff1e819bd24b6bc7436dcd781 Mon Sep 17 00:00:00 2001 From: Jake Noble Date: Wed, 25 Jun 2014 13:53:35 -0500 Subject: [PATCH 1/5] PyPI setup updates --- .gitignore | 4 ++++ README.md | 40 ++++++++++++++++++++++++++++++++++++++++ setup.py | 8 ++++---- 3 files changed, 48 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 8295e65..8dacac3 100644 --- a/.gitignore +++ b/.gitignore @@ -16,5 +16,9 @@ tmp/ .idea/ test/resources/lrs_properties.py +# release +dist +tincan.egg-info/ + # wild todo.md diff --git a/README.md b/README.md index 9b2ec9d..0f6e83f 100644 --- a/README.md +++ b/README.md @@ -75,3 +75,43 @@ The docs will be output to `docs/build/html/`. If you would like to change the names of each section, you can do so by modifying `docs/source/tincan.rst`. ## Releasing +To release to PyPI, first make sure that you have a PyPI account set up at https://pypi.python.org/pypi (and at + https://testpypi.python.org/pypi if you plan on using the test index). You will also need a .pyirc file in your + home directory with the following contents. + + [distutils] + + index-servers = + pypi + pypitest + + [pypi] # authentication details for live PyPI + repository: https://pypi.python.org/pypi + username: + password: + + [pypitest] # authentication details for test PyPI + repository: https://testpypi.python.org/pypi + username: + password: + +The pypitest contents of the .pyirc file are optional and are used for hosting to the test PyPI index. + +Update setup.py to contain the correct release version and other information. + +To test the register/upload, run the following commands in the repo directory: + + python setup.py register -r pypitest + + python setup.py sdist upload -r pypitest + +You should get no errors, and should be able to find this tincan version at https://testpypi.python.org/pypi. + +To register/upload to the live PyPI server, run the following commands in the repo directory: + + python setup.py register -r pypi + + python setup.py sdist upload -r pypi + +The new module should be now be installable with pip or easy_install. + diff --git a/setup.py b/setup.py index d3fe715..9eb5ed3 100644 --- a/setup.py +++ b/setup.py @@ -22,7 +22,7 @@ 'AICC', ], requires=[ - 'aniso8601', - 'pytz', - ] -) + 'aniso8601', + 'pytz', + ], +) \ No newline at end of file From 4cb64ca5665b0ac0dabc1412a50dddee8f5e2b3c Mon Sep 17 00:00:00 2001 From: Jake Noble Date: Wed, 25 Jun 2014 14:00:29 -0500 Subject: [PATCH 2/5] cleaning up readme some --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0f6e83f..4ee1493 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,6 @@ Update setup.py to contain the correct release version and other information. To test the register/upload, run the following commands in the repo directory: python setup.py register -r pypitest - python setup.py sdist upload -r pypitest You should get no errors, and should be able to find this tincan version at https://testpypi.python.org/pypi. @@ -110,7 +109,6 @@ You should get no errors, and should be able to find this tincan version at http To register/upload to the live PyPI server, run the following commands in the repo directory: python setup.py register -r pypi - python setup.py sdist upload -r pypi The new module should be now be installable with pip or easy_install. From 5c119889e1d44701c983aef3b88960531e3fe273 Mon Sep 17 00:00:00 2001 From: Jake Noble Date: Wed, 25 Jun 2014 14:11:51 -0500 Subject: [PATCH 3/5] cleaning up readme more --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4ee1493..b6dbd0a 100644 --- a/README.md +++ b/README.md @@ -97,14 +97,14 @@ To release to PyPI, first make sure that you have a PyPI account set up at https The pypitest contents of the .pyirc file are optional and are used for hosting to the test PyPI index. -Update setup.py to contain the correct release version and other information. +Update setup.py to contain the correct release version and any other new information. To test the register/upload, run the following commands in the repo directory: python setup.py register -r pypitest python setup.py sdist upload -r pypitest -You should get no errors, and should be able to find this tincan version at https://testpypi.python.org/pypi. +You should get no errors and should be able to find this tincan version at https://testpypi.python.org/pypi. To register/upload to the live PyPI server, run the following commands in the repo directory: From 7ce717e19999c1fbf9a4ef8626cba51b42f9840a Mon Sep 17 00:00:00 2001 From: Jake Noble Date: Wed, 25 Jun 2014 14:47:45 -0500 Subject: [PATCH 4/5] requires changed to install_requires --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 9eb5ed3..4cdfd4c 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ 'SCORM', 'AICC', ], - requires=[ + install_requires=[ 'aniso8601', 'pytz', ], From 9605cdbbe703baa13574be670bd33775ec744d1a Mon Sep 17 00:00:00 2001 From: jakednoble Date: Wed, 25 Jun 2014 15:29:27 -0500 Subject: [PATCH 5/5] More info on installation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index b6dbd0a..d89212a 100644 --- a/README.md +++ b/README.md @@ -113,3 +113,10 @@ To register/upload to the live PyPI server, run the following commands in the re The new module should be now be installable with pip or easy_install. + easy_install tincan + +or + + pip install tincan + +Use sudo as necessary.