6/24/23, 4:28 AM How to create a Python library.

Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

How to create a Python library

Kia Eisinga · Follow
Published in Analytics Vidhya
7 min read · Jan 26, 2020

Listen Share

Photo by Iñaki del Olmo on Unsplash

Ever wanted to create a Python library, albeit for your team at work or for some open
source project online? In this blog you will learn how to!

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 1/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

The tutorial is easiest to follow when you are using the same tools, however it is also
possible for you to use different ones.

The tools used in this tutorial are:

- Linux command prompt
- Visual Studio Code

Step 1: Create a directory in which you want to put your library

Open your command prompt and create a folder in which you will create your Python
library.

Remember:
- With pwd you can see your present working directory.
- With ls you can list the folders and files in your directory.
- With cd <path> you can change the current present directory you are in.
- With mkdir <folder> you can create a new folder in your working directory.

In my case, the folder I will be working with is mypythonlibrary . Change the present
working directory to be your folder.

Step 2: Create a virtual environment for your folder

When starting your project, it is always a good idea to create a virtual environment to
encapsulate your project. A virtual environment consists of a certain Python version
and some libraries.

Virtual environments prevent the issue of running into dependency issues later on. For
example, in older projects you might have worked with older versions of the numpy

library. Some old code, that once worked beautifully, might stop working once you
update its version. Perhaps parts of numpy are no longer compatible with other parts of
your program. Creating virtual environments prevents this. They are also useful in
cases when you are collaborating with someone else, and you want to make sure that
your application is working on their computer, and vice versa.

(Make sure you changed the present working directory to the folder you are going to
create your Python library in ( cd <path/to/folder> ).)

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 2/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Go ahead and create a virtual environment by typing:

> python3 -m venv venv

Once it is created, you must now activate the environment by using:

> source venv/bin/activate

Activating a virtual environment modifies the PATH and shell variables to point to the
specific isolated Python set-up you created. PATH is an environmental variable in
Linux and other Unix-like operating systems that tells the shell which directories to
search for executable files (i.e., ready-to-run programs) in response to commands
issued by a user. The command prompt will change to indicate which virtual
environment you are currently in by prepending ( yourenvname ).

In your environment, make sure you have pip installed wheel , setuptools and twine .

We will need them for later to build our Python library.

> pip install wheel

> pip install setuptools

> pip install twine

Step 3: Create a folder structure

In Visual Studio Code, open your folder mypythonlibrary (or any name you have given
your folder). It should look something like this:
Open in app Sign up Sign In

Search Medium

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 3/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

You now can start adding folders and files to your project. You can do this either
through the command prompt or in Visual Studio Code itself.

1. Create an empty file called setup.py . This is one of the most important files when
creating a Python library!

2. Create an empty file called README.md . This is the place where you can write
markdown to describe the contents of your library for other users.

3. Create a folder called mypythonlib , or whatever you want your Python library to be
called when you pip install it. (The name should be unique on pip if you want to
publish it later.)

4. Create an empty file inside mypythonlib that is called __init__.py . Basically, any
folder that has an __init__.py file in it, will be included in the library when we
build it. Most of the time, you can leave the __init__.py files empty. Upon import,
the code within __init__.py gets executed, so it should contain only the minimal
amount of code that is needed to be able to run your project. For now, we will leave
them as is.

5. Also, in the same folder, create a file called myfunctions.py .

6. And, finally, create a folder tests in your root folder. Inside, create an empty
__init__.py file and an empty test_myfunctions.py .

Your set-up should now look something like this:

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 4/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Step 4: Create content for your library

To put functions inside your library, you can place them in the myfunctions.py file. For
example, copy the haversine function in your file:

from math import radians, cos, sin, asin, sqrt

def haversine(lon1: float, lat1: float, lon2: float, lat2: float) ->
float:
"""
Calculate the great circle distance between two points on the
earth (specified in decimal degrees), returns the distance in
meters.

All arguments must be of equal length.

:param lon1: longitude of first place

:param lat1: latitude of first place
:param lon2: longitude of second place
:param lat2: latitude of second place
:return: distance in meters between the two sets of coordinates
"""
# Convert decimal degrees to radians
lon1, lat1, lon2, lat2 = map(radians, [lon1, lat1, lon2, lat2])

# Haversine formula
https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 5/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

dlon = lon2 - lon1

dlat = lat2 - lat1
a = sin(dlat/2)**2 + cos(lat1) * cos(lat2) * sin(dlon/2)**2
c = 2 * asin(sqrt(a))
r = 6371 # Radius of earth in kilometers
return c * r

This function will give us the distance in meters between two latitude and longitude
points.

Whenever you write any code, it is highly encouraged to also write tests for this code.
For testing with Python you can use the libraries pytest and pytest-runner . Install the
library in your virtual environment:
> pip install pytest==4.4.1

> pip install pytest-runner==4.4

Let’s create a small test for the haversine function. Copy the following and place it
inside the test_myfunctions.py file:

from mypythonlib import myfunctions

def test_haversine():
assert myfunctions.haversine(52.370216, 4.895168, 52.520008,
13.404954) == 945793.4375088713

Finally, let’s create a setup.py file, that will help us to build the library. A limited
version of setup.py will look something like this:

from setuptools import find_packages, setup

setup(
name='mypythonlib',
packages=find_packages(),
version='0.1.0',
description='My first Python library',
author='Me',
license='MIT',
)

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 6/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

The name variable in setup holds whatever name you want your package wheel file to
have. To make it easy, we will gave it the same name as the folder.

Set the packages you would like to create

While in principle you could use find_packages() without any arguments, this can
potentially result in unwanted packages to be included. This can happen, for example, if
you included an __init__.py in your tests/ directory (which we did). Alternatively,
you can also use the exclude argument to explicitly prevent the inclusion of tests in the
package, but this is slightly less robust. Let’s change it to the following:

from setuptools import find_packages, setup

setup(
name='mypythonlib',
packages=find_packages(include=['mypythonlib']),
version='0.1.0',
description='My first Python library',
author='Me',
license'MIT',
)

Set the requirements your library needs

Note that pip does not use requirements.yml / requirements.txt when your project is
installed as a dependency by others. Generally, for that, you will have to specify
dependencies in the install_requires and tests_require arguments in your setup.py

file.

Install_requires should be limited to the list of packages that are absolutely needed.
This is because you do not want to make users install unnecessary packages. Also note
that you do not need to list packages that are part of the standard Python library.

However, since we have only defined the haversine function so far and it only uses the
math library (which is always available in Python), we can leave this argument empty.

Maybe you can remember us installing the pytest library before. Of course, you do not
want to add pytest to your dependencies in install_requires : it isn’t required by the

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 7/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

users of your package. In order to have it installed automatically only when you run
tests you can add the following to your setup.py :

from setuptools import find_packages, setup

setup(
name='mypythonlib',
packages=find_packages(include=['mypythonlib']),
version='0.1.0',
description='My first Python library',
author='Me',
license='MIT',
install_requires=[],
setup_requires=['pytest-runner'],
tests_require=['pytest==4.4.1'],
test_suite='tests',
)

Running:
> python setup.py pytest

will execute all tests stored in the ‘tests’ folder.

Step 5: Build your library

Now that all the content is there, we want to build our library. Make sure your present
working directory is /path/to/mypythonlibrary (so the root folder of your project). In
your command prompt, run:
> python setup.py bdist_wheel

Your wheel file is stored in the “dist” folder that is now created. You can install your
library by using:
> pip install /path/to/wheelfile.whl

Note that you could also publish your library to an internal file system on intranet at
your workplace, or to the official PyPI repository and install it from there.

Once you have installed your Python library, you can import it using:
import mypythonlib

from mypythonlib import myfunctions

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 8/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Python Pip Python Programming

Follow

Written by Kia Eisinga

229 Followers · Writer for Analytics Vidhya

Data Scientist at TomTom

More from Kia Eisinga and Analytics Vidhya

Harikrishnan N B in Analytics Vidhya

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 9/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Confusion Matrix, Accuracy, Precision, Recall, F1 Score

Binary Classification Metric

6 min read · Dec 10, 2019

529 6

Kathryn in Analytics Vidhya

Efficient Way to Activate Conda in VSCode

I was struggling quite a bit while I started to use VSCode, because there is a lot flexibility in
VSCode, but it also implies that there…

7 min read · May 27, 2020

247 5

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 10/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Hannan Satopay in Analytics Vidhya

The Ultimate Markdown Guide (for Jupyter Notebook)

An in-depth guide for Markdown syntax usage for Jupyter Notebook

10 min read · Nov 18, 2019

1.8K 12

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 11/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Sumedh Datar in Analytics Vidhya

Application of Foreground and Background separation with Deep

Learning
Foreground and background separation had always been a huge problem before the onset of
object detection based neural networks. Techniques…

3 min read · Apr 19, 2021

10.1K

See all from Kia Eisinga

See all from Analytics Vidhya

Recommended from Medium

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 12/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Leonie Monigatti in Towards Data Science

10 Exciting Project Ideas Using Large Language Models (LLMs) for Your
Portfolio
Learn how to build apps and showcase your skills with large language models (LLMs). Get
started today!

· 11 min read · May 15

1.5K 8

Youssef Hosni in Level Up Coding

20 Pandas Functions for 80% of your Data Science Tasks

Master these Functions and Get Your Work Done

· 16 min read · Jan 22

2.2K 12

Lists

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 13/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Coding & Development

11 stories · 4 saves

Predictive Modeling w/ Python

18 stories · 13 saves

Practical Guides to Machine Learning

10 stories · 26 saves

New_Reading_List
173 stories · 1 save

Xiaoxu Gao in Towards Data Science

From Novice to Expert: How to Write a Configuration file in Python

Treat config file like your production code

· 9 min read · Dec 28, 2020

1.3K 14

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 14/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Zach Quinn in Pipeline: Your Data Engineering Resource

3 Data Science Projects That Got Me 12 Interviews. And 1 That Got Me in

Trouble.
3 work samples that got my foot in the door, and 1 that almost got me tossed out.

· 7 min read · Aug 29, 2022

3.2K 46

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 15/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Dr. Derek Austin 🥳 in Better Programming

Why I Prefer Regular Merge Commits Over Squash Commits

I used to think squash commits were so cool, and then I had to use them all day, every day.
Here’s why you should avoid squash

· 5 min read · Sep 30, 2022

1.1K 51

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 16/17
6/24/23, 4:28 AM How to create a Python library. Ever wanted to create a Python library… | by Kia Eisinga | Analytics Vidhya | Medium

Tableau dashboard featuring Udemy data.

Zach Quinn in Pipeline: Your Data Engineering Resource

Creating The Dashboard That Got Me A Data Analyst Job Offer

A walkthrough of the Udemy dashboard that got me a job offer from one of the biggest names in
academic publishing.

· 9 min read · Dec 5, 2022

1.1K 16

See more recommendations

https://medium.com/analytics-vidhya/how-to-create-a-python-library-7d5aea80cc3f 17/17