Overview of Auto Pypi¶

Why Should I Use This?¶

This is a Python command line tool to automatically setup your (updated version) python package onto PyPi.

As you may know, PyPi indexes (both real and test index) do not allow you to reuse package name (considering version numner), which means you can not upload your package with the same package name together with an identical version numner.

In another word, you have to change the version number in your setup.py file before each time you want to upload your modified package. What’s more, you also need to remove the old build and egg folder before you run the setup tools.

You’ll find it not convenient at all if you are uploading and testing your package frequently. Even if you are not going to upload and test frequently, each time you remove the previous setup related folders comes with some risks and is still time-consuming.

By using this command line tool, you will be all set after a single command autopypi. The only thing you need to care about now is the package version number.

You could chage the version number in the setup.py file as usual, but I highly recommend you to change a little bit in your setup.py file making the version number as an input value from the terminal:

version_number = input("Input the new version number you are going to use: ")

setuptools.setup(
    name="auto_pypi",
    version=version_number,
    author="Sen LEI",
    ...)

By doing this, you just need to run the command autopypi, and specify a version number later when it pops up.

Usage¶

Use As A Command Line Tool¶

Usage: autopypi [OPTIONS] PKG_DIR

  Python command line tool to setup Python package automatically.
  Example:      $ autopypi your-package-root-directory -r
  Example:      $ cd your-package-root-directory
                $ autopypi . -r

Options:
  -r, --real          Use the real PyPi index (instead of test PyPi).
  --help              Show this message and exit.

Documentation¶

Check out the latest auto_pypi documentation at Read the Docs

Contributing¶

Please send pull requests, very much appriciated.

Fork the repository on GitHub.
Make a branch off of master and commit your changes to it.
Create a Pull Request with your contribution