Publish a (Perfect) Python Package on PyPI

Speaker

Mark Smith

Material

• video
• resource

Note

Basic Usage

• minimal setup.py

from setuptools import setup

setup(
    name="helloworld",
    version="0.0.1",
    description="Say hello!",
    py_modules=["helloworld"],
    package_dir={'': 'src'},
)

• build wheel

python setup.py bdist_wheel

• test installation locally
  • Links to the code instead of add it to site-packages

pip install -e .

Documentation

• Compare ReStructured Text and markdown

• keys added to setup.py
  • classifiers
  • long_description
  • long_description_content_type="text/markdown"

Dependencies

• keys added to setup.py
  • install_requires
  • extras_require
    • dev
• install package with extras_require

pip install -e .[dev]

Source Distribution

python setup.py sdist

• keys added to setup.py
  • url
  • author
  • author_email
• Ideally, everything should be included for source distribution
  • Use check-manifest
    • check-manifest --create

Publish

python setup.py bdist_wheel sdist
twine upload dist/*

Other Stuffs to add

• Must Do
  • tox
  • Continuous Integration
• Nice to have
  • badges
    • code coverage
    • quality metrics
  • test on macOS & windows
  • more document
    • contributors section
    • Code of Conduct

Don't do any thing mention above

• Use cookiecutter
  • cookiecutter-pylibrary

Things are changing

• move metadata from setup.py to setup.cfg
• move to pyprojec.toml
  • poetry
  • flit
  • hatch

Share on: Twitter ❄ Facebook ❄ Email