How to Create Python Packages
Have you faced the problem of writing same lines of code for every project? That’s where python packaging come to the rescue. A Python package is nothing but a folder containing some modules inside it. Python packages have made our life easy as we just have to import the functionality we need from the required package. Just imagine if someone had not built those packages, how tedious life of programmers had been.
This blog aims to cover the basics and what you need to publish a python package successfully.
Structure of the Project
To initialize a folder as a Python package we need to create a file called
__init__.py inside the folder.
__init__.py will run everytime we try to import the package in our project.
setup.py is crucial which contains the metadata of our package and binds everything our module have. It allows us to do
python setup.py install and
# Always prefer setuptools over distutils
from setuptools import setup, find_packages
# To use a consistent encoding
from codecs import open
from os import path
here = path.abspath(path.dirname(__file__))
# Get the long description from the README file
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
long_description = f.read()
version = open('VERSION').read().strip()
requirements = open('requirements.txt').read().split('\n')
description='what does the package do',
author = 'author name',
author_email = 'author email',
name - This is the name our package
version - The version number to be visible on PyPi website
description - The description of the package to be displayed on the PyPi website
long description - detailed description of the package and usage
author - name of the author to be displayed on PyPi website
author_email -author’s email to be displayed on PyPi website
packages - The packages to be built and uploaded to the PyPi website
install_requires - Package dependency
python_requires - Minimum python version requirement
There are multiple types of python package builds:
- Wheels - Binary builds for each platform or universal. Highly recommended.
- Eggs - Deprecated. Don’t use.
- Source tars - When wheel for target platform is unavailable, setup.py from source code is run again during installing
Upload to PyPi
PyPi is where we can store all the built packages/source tars. We need to first upload the package to PyPi website before we can do pip install.
To start the upload, first sign up on the PyPi website and install the
twine python package to upload any package.
python3 -m pip install --upgrade twine
Next, we build our package for distribution:
python3 -m build
After the build command, we will see dist folder in the root directory of the root directory of our project. These distribution files are created by python which can be installed on any system.
The final step is to upload the distribution files to the website.
python3 -m twine upload --repository testpypi dist/
This will prompt for username and password after which the package will be uploaded to the website.
- Regression tests: Write these tests whenever you fix a bug - so that we never ever encounter them again.
- Unit tests: Write these tests for every new feature built.
Super simple instructions to write tests for python package:
ln -s ../your_package_name .
touch test.py # write your tests here
You have now successfully created your own custom python package and uploaded it to PyPi website. You can now simply do pip install packagename and use it in any project required.