Quickstart: Packaging in Python

Creating your first Python package can be intimidating, but it doesn’t have to be! Below are the basic instructions, with up-to-date links to examples for each step, and links to best practices. Steps 5 and 6 show options to make your package pip installable, whether your package is public or private.

1. Add a setup.py script in the project root.
   • Official pypa example setup.py: https://github.com/pypa/sampleproject/blob/master/setup.py
   • More thorough explanations: https://packaging.python.org/tutorials/distributing-packages/
   • Note: To include tests, add the following:
     • In setup.py

       Python

       from setuptools import setup setup( #..., setup_requires=['pytest-runner', ...], tests_require=['pytest', ...], #..., )

       1 2 3 4 5 6 7 8

       from setuptools import setup   setup( #..., setup_requires=['pytest-runner', ...], tests_require=['pytest', ...], #..., )

       In setup.cfg (to set up alias)

       Python

       [aliases] test=pytest

       1 2	[aliases] test=pytest

       From the terminal

       Shell

       python setup.py test

       1	python setup.py test

2. Optional: Add setup.cfg file.
   • Official pypa example: https://github.com/pypa/sampleproject/blob/master/setup.cfg
3. Optional: Package using python setup.py sdist 
   • This will create a dist folder containing all of your distributions
4. Push ( git push ) to remote (public or private) git repository
5. Install from remote repository
   • • Full Options: https://pip.pypa.io/en/stable/reference/pip_install/#git
     • Private repo example: pip install git+ssh://git@git.server:port/path/repo.git@branch_name
     • Public repo example: pip install git+ https://github.com/github_user/repo.git@branch_name
6. Optional: Upload to PyPi
   1. Register your package: python setup.py register
   2. Upload your package:  python setup.py sdist upload
   3. What to do if you get a message like:  error: Upload failed (403): Invalid or non-existent authentication information. : Create a  ~/.pypirc  file with the following contents:
      
      Python

      [distutils] index-servers = pypi [pypi] repository: https://pypi.python.org/pypi username: <username> password: <pass>

      1 2 3 4 5 6 7 8

      [distutils] index-servers =     pypi   [pypi] repository: https://pypi.python.org/pypi username: <username> password: <pass>