How to publish python package to pypi

PythonHow-ToBeginner · 4 min read

How to Publish a Python Package to PyPI Quickly and Easily

To publish a Python package to PyPI, first prepare your package with a setup.py or pyproject.toml file, then build distribution files using python -m build. Finally, upload your package to PyPI using twine upload dist/* after registering an account on pypi.org.

📐

Syntax

Publishing a Python package involves these main commands:

python -m build: Builds source and wheel distribution files.
twine upload dist/*: Uploads the built files to PyPI.

You need a setup.py or pyproject.toml file in your project root describing your package metadata.

bash

python -m build

twine upload dist/*

💻

Example

This example shows a minimal setup.py file and the commands to build and upload a package named mypackage.

python

from setuptools import setup, find_packages

setup(
    name='mypackage',
    version='0.1.0',
    packages=find_packages(),
    description='A simple example package',
    author='Your Name',
    author_email='you@example.com',
    url='https://github.com/yourusername/mypackage',
    classifiers=[
        'Programming Language :: Python :: 3',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
    ],
    python_requires='>=3.6',
)

# Commands to run in terminal:
# python -m build
# twine upload dist/*

⚠️

Common Pitfalls

Common mistakes when publishing to PyPI include:

Not registering an account on pypi.org before uploading.
Missing or incorrect metadata in setup.py or pyproject.toml.
Forgetting to build distribution files before uploading.
Uploading without using twine, which is the recommended secure tool.
Trying to upload a package version that already exists on PyPI.

Always check your package metadata and version number carefully.

bash

## Wrong way: Uploading without building
# twine upload mypackage-0.1.0.tar.gz

## Right way: Build first, then upload
# python -m build
# twine upload dist/*

📊

Quick Reference

Steps to publish your Python package:

Create setup.py or pyproject.toml with package info.
Register an account on pypi.org.
Install build tools: pip install build twine.
Build your package: python -m build.
Upload to PyPI: twine upload dist/*.
Verify your package is live on PyPI.

✅

Key Takeaways

Prepare your package metadata correctly in setup.py or pyproject.toml before publishing.

Always build distribution files using python -m build before uploading.

Use twine to securely upload your package to PyPI.

Increment your package version for every new upload to avoid conflicts.