DEV Community

Cover image for How to Create and Publish a Python Package on PyPI 🐍
Athreya aka Maneshwar
Athreya aka Maneshwar

Posted on • Edited on

How to Create and Publish a Python Package on PyPI 🐍

#webdev #beginners #programming #python

Hello, I'm Maneshwar. I'm building git-lrc, an AI code reviewer that runs on every commit. It is free, unlimited, and source-available on Github. Star Us to help devs discover the project. Do give it a try and share your feedback for improving the product.

Publishing your first Python package on PyPI (Python Package Index) feels like sending your code off to college—it’s out there in the world, ready to make you proud (and maybe help someone too).

In my case, I was working on my own version of mkdocs-material.

Initially, I was all about the UI—just trying to get it to look goodand work as intended. After some effort, I had something usable and thought, "Alright, let's figure out the deployment."

The original mkdocs uses a Python package for its installer, so you can just pip install mkdocs, mkdocs new ., and then mkdocs build to convert markdown files into HTML.

It’s simple, elegant, and works like a charm.

I wanted the same experience for my project—an easy pip install setup to make deploying my version of mkdocs-material.

So, it was my time to learn how to build my own Python package and publish it. And that’s exactly what we’ll do here, step by step.

Don’t worry—it’s easier than debugging a Friday night code bug XD

Step 1: Structure 📂

A well-structured project is like a clean kitchen—you can find your tools (or code) easily and avoid unnecessary messes.

Here's what our project layout will look like:

├── dev_to/
│   ├── __init__.py        
│   ├── say_hello.py       # Your module code
├── tests/
│   ├── test_say_hello.py  
├── README.md              
├── setup.py               # Package metadata
├── pyproject.toml         # Build system config
├── LICENSE
Enter fullscreen mode Exit fullscreen mode

Step 2: Code 📝

This is the heart of your package—what it does and why it exists.

  • dev_to/say_hello.py A simple function that greets users: 
  def say_hello(name):
      return f"Hello dev.to, from {name}!"
Enter fullscreen mode Exit fullscreen mode
  • dev_to/__init__.py Makes your function accessible at the package level: 
  from .say_hello import say_hello
Enter fullscreen mode Exit fullscreen mode

Step 3: Tests ✅

Tests ensure your code behaves as expected and helps you avoid embarrassing bugs. Trust me, your future self will thank you.

  • tests/test_say_hello.py A basic test script: 
  from dev_to import say_hello

  def test_say_hello():
      result = say_hello("World")
      assert result == "Hello dev.to, from World!"
      print("Test passed!")

  if __name__ == "__main__":
      test_say_hello()
Enter fullscreen mode Exit fullscreen mode 
$ p tests/test_say_hello.py 
Test passed!
Enter fullscreen mode Exit fullscreen mode

Step 4: Metadata

Metadata describes your package what it is, who made it, and how others can use it.

  • setup.py Configure your package: 
  from setuptools import setup, find_packages

  setup(
      name="dev_to",
      version="0.1.0",
      author="lovestaco",
      description="A simple example package",
      long_description=open("README.md").read(),
      long_description_content_type="text/markdown",
      url="https://github.com/lovestaco/dev_to",
      packages=find_packages(),
      classifiers=[
          "Programming Language :: Python :: 3",
          "License :: OSI Approved :: MIT License",
          "Operating System :: OS Independent",
      ],
      python_requires=">=3.6",
  )
Enter fullscreen mode Exit fullscreen mode
  • pyproject.toml Declare the build system: 
  [build-system]
  requires = ["setuptools", "wheel"]
  build-backend = "setuptools.build_meta"
Enter fullscreen mode Exit fullscreen mode

Step 5: Build the Package

Building generates the distributable files required for publishing.

Install the tools:

pip install build
Enter fullscreen mode Exit fullscreen mode

Build your package:

python -m build
Enter fullscreen mode Exit fullscreen mode

This creates a dist/ folder containing .tar.gz and .whl files.

$ python -m build
* Creating isolated environment: virtualenv+pip...
* Installing packages in isolated environment:
  - setuptools
  - wheel
.
.
.
adding 'dev_to-0.1.0.dist-info/RECORD'
removing build/bdist.linux-x86_64/wheel
Successfully built dev_to-0.1.0.tar.gz and dev_to-0.1.0-py3-none-any.whl
Enter fullscreen mode Exit fullscreen mode

Step 6: Moment of Truth

Install the package locally:

pip install dist/dev_to-0.1.0-py3-none-any.whl
Enter fullscreen mode Exit fullscreen mode

Try it out:

Step 7: Publish to PyPI 🚀

Install Twine:

pip install twine
Enter fullscreen mode Exit fullscreen mode

Upload your package:

python -m twine upload dist/*
Enter fullscreen mode Exit fullscreen mode

You'll need your PyPI credentials. Once uploaded, your package is live! 🎉

Install it like this:

pip install dev-to
Enter fullscreen mode Exit fullscreen mode

![Image descriLiveAPI helps you get all your backend APIs documented in a few minutes

With LiveAPI, you can quickly generate interactive API documentation that allows users to execute APIs directly from the browser.

git-lrc
*AI agents write code fast. They also silently remove logic, change behavior, and introduce bugs -- without telling you. You often find out in production.

git-lrc fixes this. It hooks into git commit and reviews every diff before it lands. 60-second setup. Completely free.*

Any feedback or contributors are welcome! It's online, source-available, and ready for anyone to use.

⭐ Star it on GitHub:

GitHub logo HexmosTech / git-lrc

Free, Unlimited AI Code Reviews That Run on Commit

git-lrc logo

git-lrc

Free, Unlimited AI Code Reviews That Run on Commit


git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

AI agents write code fast. They also silently remove logic, change behavior, and introduce bugs -- without telling you. You often find out in production.

git-lrc fixes this. It hooks into git commit and reviews every diff before it lands. 60-second setup. Completely free.

See It In Action

See git-lrc catch serious security issues such as leaked credentials, expensive cloud operations, and sensitive material in log statements

git-lrc-intro-60s.mp4

Why

  • 🤖 AI agents silently break things. Code removed. Logic changed. Edge cases gone. You won't notice until production.
  • 🔍 Catch it before it ships. AI-powered inline comments show you exactly what changed and what looks wrong.
  • 🔁 Build a habit, ship better code. Regular review → fewer bugs → more robust code → better results in your team.
  • 🔗 Why git? Git is universal. Every editor, every IDE, every AI…


View on GitHub


Top comments (2)

Collapse
 
kamalhinduja profile image
Kamal Hinduja •

Great information.

Collapse
 
lovestaco profile image
Athreya aka Maneshwar •

Thanks :)