Skip to content

Updated to use Twine #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated to use Twine #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions minimal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,37 +71,44 @@ Anywhere else in our system using the same Python, we can do this now::
Publishing On PyPI
~~~~~~~~~~~~~~~~~~

The ``setup.py`` script is also our main entrypoint to register the package name on PyPI and upload source distributions.

To "register" the package (this will reserve the name, upload package metadata, and create the pypi.python.org webpage)::
We'll probably want to upload a source distribution so that the package can be installed without cloning the repository. This will also enable automated installation and dependency resolution tools to install our package.

$ python setup.py register
First create a source distribution with the setup.py command::

If you haven't published things on PyPI before, you'll need to create an account by following the steps provided at this point.
$ python setup.py sdist
running sdist
...
Writing funniest-0.1/setup.cfg
Creating tar archive

At this point you can view the (very minimal) page on PyPI describing **funniest**:
This will create ``dist/funniest-0.1.tar.gz`` inside our top-level directory. If you like, copy that file to another host and try unpacking it and install it, just to verify that it works for you. The s in sdist is for ‘source’. You can also create pre-built wheels by using bdist, for more information about those, see PyPA’s page on packaging.

http://pypi.python.org/pypi/funniest/0.1
We can see in the run output that our package has been built.

Although users can follow the URL link to find our git repository, we'll probably want to upload a source distribution so that the package can be installed without cloning the repository. This will also enable automated installation and dependency resolution tools to install our package.
Now that we have our built package, we can proceed to upload our code. PyPA recommends using Twine rather than setup.py commands, as setup.py may transmit your passwords in plaintext. So we will need to install Twine.

$ pip install twine

First create a source distribution with::
After Twine is installed, we can open the Terminal (Alt+F12) and run

$ python setup.py sdist
$ twine upload dist/*

This will create ``dist/funniest-0.1.tar.gz`` inside our top-level directory. If you like, copy that file to another host and try unpacking it and install it, just to verify that it works for you.
This will reserve the name, upload package metadata, and create the pypi.python.org webpage.

That file can then be uploaded to PyPI with::
The ``setup.py`` script is also our main entrypoint to register the package name on PyPI and upload source distributions.

[Warning: the ``python setup.py`` method might not work anymore and if it does, might be less secure. Just make an account online.]
The other way to "register" the package ()::

$ python setup.py sdist upload
$ python setup.py register

You can combine all of these steps, to update metadata and publish a new build in a single step::
If you haven't published things on PyPI before, you'll need to create an account by following the steps provided at this point.

$ python setup.py register sdist upload

For a detailed list of all available setup.py commands, do::
At this point you can view the (very minimal) page on PyPI describing **funniest**:

$ python setup.py --help-commands
http://pypi.python.org/pypi/funniest/0.1


Installing the Package
Expand Down