How to Host your Python Package on PyPI with GitHub
PyPI is the official Python Packages Index. Once you publish it on PyPI, then it can be downloaded via a simple command
pip install <package>. Life becomes simpler with this one line.
1: Create accounts
In order to submit your package on PyPI, you need to have a few accounts on the PyPI website. These accounts will enable you to maintain your packages and will provide you with an interface to edit your package.
Create your account on following sites:
Now, create a file in your home folder named
.pypirc, which will be your configuration file that holds the authentication information of your PyPI accounts.
Create a file
.pypirc and put the contents shown below
.pypirc file contents
[distutils] index-servers = pypi pypitest [pypi] repository: https://pypi.python.org/pypi username: YOUR_USERNAME_HERE password: YOUR_PASSWORD_HERE [pypitest] repository: https://testpypi.python.org/pypi username: YOUR_USERNAME_HERE password: YOUR_PASSWORD_HERE
You should replace
YOUR_PASSWORD_HERE with your username and password from PyPI sites that you just created.
3: The Python Package directory structure
source_diris a root directory that contains your python package
my_python_packageis your main python package that you want to publish
source_dir/ # the source directory |-- my_python_package # your package | |-- __init__.py | `-- FILES .... # your package files |-- README.md |-- setup.cfg |-- setup.py
Setup your directory structure as shown above, with appropriate changes, and host it on github.com.
4: Release on GitHub and get the download link
This step involves releasing your package on GitHub. This will create a download link of your complete source. In order to release your GitHub project, you need to carry on following steps:
- Go to your project homepage on GitHub
- On top, you will see Release link. Click on it.
- Click on Draft a new relase
- Fill in all the details
- Tag version should be the version number of your package release
- Release Title can be anything you want.
- Click Publish release at the bottom of the page
- Now under Releases you can view all of your releases.
- Copy the download link (tar.gz) and save it somewhere.
5: Editing files
Open the setup.py file and add following skeleton to it
from distutils.core import setup setup( name = 'my_python_package', packages = ['my_python_package'], version = 'version number', # Ideally should be same as your GitHub release tag varsion description = 'description', author = '', author_email = '', url = 'github package source url', download_url = 'download link you saved', keywords = ['tag1', 'tag2'], classifiers = , )
Open the setup.cfg file and add following skeleton to it
[metadata] description-file = README.md
Now push everything to GitHub.
6: Publish the package
Execute following commands
python setup.py register -r pypitest
This command will try to register your package on PyPI test server. This makes sure that everything you have setup is correct.
python setup.py sdist upload -r pypitest
This command will upload your package on test repository and now you should see your package on PyPI Test
Now you are ready to publish your package on PyPI Live Server! Execute following commands
python setup.py register -r pypi python setup.py sdist upload -r pypi
Congratulations! You just published your python package on PyPI
Reference: Official Documentation