aster.cloud aster.cloud
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
aster.cloud aster.cloud
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
  • Programming
  • Software
  • Technology
  • Tools

How To Package Your Python Code

  • Aelia Vita
  • November 22, 2021
  • 3 minute read

Use setuptools to deliver Python code to users.

You’ve spent weeks perfecting your code. You’ve tested it and sent it to some close developer friends for quality assurance. You’ve posted all the source code on your personal Git server, and you’ve received helpful bug reports from a few brave early adopters. And now you’re ready to make your Python code available to the world.

And that’s when it hits you. You have no idea how to deliver the product.Delivering code to its target is a big deal. It’s a whole branch of software development, it’s the “D” in CI/CD, and yet many people forget all about, at least until the end. I’ve written articles about Autotools and Cmake, but some languages have their own methods to help you make your code readily available to users. For Python, a common way to deliver code to users is with setuptools.


Partner with aster.cloud
for your next big idea.
Let us know here.



From our partners:

CITI.IO :: Business. Institutions. Society. Global Political Economy.
CYBERPOGO.COM :: For the Arts, Sciences, and Technology.
DADAHACKS.COM :: Parenting For The Rest Of Us.
ZEDISTA.COM :: Entertainment. Sports. Culture. Escape.
TAKUMAKU.COM :: For The Hearth And Home.
ASTER.CLOUD :: From The Cloud And Beyond.
LIWAIWAI.COM :: Intelligence, Inside and Outside.
GLOBALCLOUDPLATFORMS.COM :: For The World's Computing Needs.
FIREGULAMAN.COM :: For The Fire In The Belly Of The Coder.
ASTERCASTER.COM :: Supra Astra. Beyond The Stars.
BARTDAY.COM :: Prosperity For Everyone.

Install setuptools

The easiest way to install and update setuptools is with pip:

<span class="co4">$ </span><span class="kw2">sudo</span> python <span class="re5">-m</span> pip <span class="kw2">install</span> <span class="re5">--upgrade</span> setuptools

Example library

Create a simple Python library called myhellolib for some example code in need of packaging. This library accepts a string and then prints the string in capital letters.
It’s two lines of code, but project structure is important, so first create the directory tree:

<span class="co4">$ </span><span class="kw2">mkdir</span> <span class="re5">-p</span> myhellolib.git<span class="sy0">/</span>myhellolib

To confirm that this project is an importable library (a Python “module”), create the empty file __init__.py in the code directory, along with the file that contains the code:

$ touch myhellolib.git/myhellolib/__init__.py
$ touch myhellolib.git/myhellolib/myhellolib.py

In the myhellolib.py file, enter this simple Python code:

def greeter(s):
print(s.upper())

That’s the library written.

Read More  My First Pull Request At Age 14

Test it

Before packaging it up, test your library. Create a myhellolib.git/test.py file and enter this code:

import myhellolib.myhellolib as hello

hello.greeter(“Hello Opensource.com.”)

Run the script:

$ cd myhellolib.git
$ python ./test.py
HELLO OPENSOURCE.COM

It works, so now you can package it up.

Setuptools

To package a project with setuptools, you must create a .toml file identifying setuptools as the build system. Place this text in a file called myhellolib.toml in your project directory:

[build-system] requires = [“setuptools”, “wheel”] build-backend = “setuptools.build_meta”

Next, create a file called setup.py, containing metadata about your project:

from setuptools import setup

setup(
name=‘myhellolib’,
version=‘0.0.1’,
packages=[‘myhellolib’],
install_requires=[
‘requests’,
‘importlib; python_version == “3.8”‘,
],
)

Believe it or not, that’s all the setup setuptools requires. Your project is ready for packaging.

Packaging Python

To create your Python package, you need a builder. A common tool is build, which you can install with pip:

<span class="co4">$ </span>python <span class="re5">-m</span> pip <span class="kw2">install</span> build <span class="re5">--user</span>

Build your project:

<span class="co4">$ </span>python <span class="re5">-m</span> build

After a few moments, the build completes, and there’s a new directory in your project folder called dist. This folder contains a .tar.gz and a .whl file.
Your very first Python package! Here’s what each one contains:

$ tar –list –file dist/myhellolib-0.0.1.tar.gz
myhellolib-0.0.1/
myhellolib-0.0.1/PKG-INFO
myhellolib-0.0.1/myhellolib/
myhellolib-0.0.1/myhellolib/__init__.py
myhellolib-0.0.1/myhellolib/myhellolib.py
myhellolib-0.0.1/myhellolib.egg-info/
myhellolib-0.0.1/myhellolib.egg-info/PKG-INFO
myhellolib-0.0.1/myhellolib.egg-info/SOURCES.txt
myhellolib-0.0.1/myhellolib.egg-info/dependency_links.txt
myhellolib-0.0.1/myhellolib.egg-info/requires.txt
myhellolib-0.0.1/myhellolib.egg-info/top_level.txt
myhellolib-0.0.1/setup.cfg
myhellolib-0.0.1/setup.py$ unzip -l dist/myhellolib-0.0.1-py3-none-any.whl
Archive:  dist/myhellolib-0.0.1-py3-none-any.whl
Name
—-
myhellolib/__init__.py
myhellolib/myhellolib.py
myhellolib-0.0.1.dist-info/METADATA
myhellolib-0.0.1.dist-info/WHEEL
myhellolib-0.0.1.dist-info/top_level.txt
myhellolib-0.0.1.dist-info/RECORD
——-
6 files

Making it available

Now that you know how easy it is to package up your Python package, you can either automate the process using Git hooks, GitLab webhooks, Jenkins, or a similar automation tool. You can even upload your project to PyPi, the popular repository for Python modules. Once it’s on PyPi, users can install it using pip, the same way you installed setuptools and build for this article!

Read More  Google I/O 2019 | The State of Unity on Android

It’s not often the first thing you think about when sitting down to develop an application or library, but packaging code is an important aspect of programming. Python developers put a lot of thought into how programmers can make their work available to the world, and it doesn’t get much easier than setuptools. Try it out, use it, and keep coding in Python!

This feature was republished from Opensource.

For enquiries, product placements, sponsorships, and collaborations, connect with us at [email protected]. We'd love to hear from you!

Our humans need coffee too! Your support is highly appreciated, thank you!

Aelia Vita

Related Topics
  • Cmake
  • Open Source
  • Programming
  • Python
  • Python library
You May Also Like
View Post
  • Technology

Advanced audio dialog and generation with Gemini 2.5

  • June 15, 2025
View Post
  • Computing
  • Multi-Cloud
  • Technology

Global cloud spending might be booming, but AWS is trailing Microsoft and Google

  • June 13, 2025
View Post
  • Computing
  • Multi-Cloud
  • Technology

Google Cloud, Cloudflare struck by widespread outages

  • June 12, 2025
View Post
  • Computing
  • Multi-Cloud
  • Technology

What is PC as a service (PCaaS)?

  • June 12, 2025
View Post
  • Technology

Apple services deliver powerful features and intelligent updates to users this autumn

  • June 11, 2025
View Post
  • Computing
  • Multi-Cloud
  • Technology

By the numbers: Use AI to fill the IT skills gap

  • June 11, 2025
View Post
  • Computing
  • Multi-Cloud
  • Technology

Crayon targets mid-market gains with expanded Google Cloud partnership

  • June 10, 2025
Apple-WWDC25-Apple-Intelligence-hero-250609
View Post
  • Featured
  • Technology

Apple Intelligence gets even more powerful with new capabilities across Apple devices

  • June 9, 2025

Stay Connected!
LATEST
  • 1
    Advanced audio dialog and generation with Gemini 2.5
    • June 15, 2025
  • 2
    A Father’s Day Gift for Every Pop and Papa
    • June 13, 2025
  • 3
    Global cloud spending might be booming, but AWS is trailing Microsoft and Google
    • June 13, 2025
  • Google Cloud, Cloudflare struck by widespread outages
    • June 12, 2025
  • What is PC as a service (PCaaS)?
    • June 12, 2025
  • 6
    Apple services deliver powerful features and intelligent updates to users this autumn
    • June 11, 2025
  • By the numbers: Use AI to fill the IT skills gap
    • June 11, 2025
  • 8
    Crayon targets mid-market gains with expanded Google Cloud partnership
    • June 10, 2025
  • Apple-WWDC25-Apple-Intelligence-hero-250609 9
    Apple Intelligence gets even more powerful with new capabilities across Apple devices
    • June 9, 2025
  • Apple-WWDC25-Liquid-Glass-hero-250609_big.jpg.large_2x 10
    Apple introduces a delightful and elegant new software design
    • June 9, 2025
about
Hello World!

We are aster.cloud. We’re created by programmers for programmers.

Our site aims to provide guides, programming tips, reviews, and interesting materials for tech people and those who want to learn in general.

We would like to hear from you.

If you have any feedback, enquiries, or sponsorship request, kindly reach out to us at:

[email protected]
Most Popular
  • 1
    Apple supercharges its tools and technologies for developers to foster creativity, innovation, and design
    • June 9, 2025
  • Robot giving light bulb to businessman. Man sitting with laptop on money coins flat vector illustration. Finance, help of artificial intelligence concept for banner, website design or landing web page 2
    FinOps X 2025: IT cost management evolves for AI, cloud
    • June 9, 2025
  • 3
    AI security and compliance concerns are driving a private cloud boom
    • June 9, 2025
  • 4
    It’s time to stop debating whether AI is genuinely intelligent and focus on making it work for society
    • June 8, 2025
  • person-working-html-computer 5
    8 benefits of AI as a service
    • June 6, 2025
  • /
  • Technology
  • Tools
  • About
  • Contact Us

Input your search keywords and press Enter.