Hoe maak je een Python-pakket en publiceer je het?

Door een Python-pakket te maken en te publiceren, kunt u uw code delen met de bredere Python-community. In deze handleiding doorlopen we de stappen om een ​​Python-pakket te maken en te publiceren naar de Python Package Index (PyPI), waar anderen het eenvoudig kunnen installeren en gebruiken.

Uw project instellen

Voordat u begint, moet u ervoor zorgen dat Python op uw systeem is geïnstalleerd. U moet ook de pakketten setuptools en wheel installeren als u dat nog niet hebt gedaan:

pip install setuptools wheel

De pakketstructuur maken

Maak een nieuwe directory voor uw pakketproject. Maak binnen deze directory de volgende structuur:

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

Hier volgt een kort overzicht van deze bestanden:

• your_package/__init__.py: Markeert de directory als een Python-pakket.
• your_package/module1.py en your_package/module2.py: De modules van uw pakket.
• tests/: Directory voor de testcases van uw pakket.
• setup.py: Het buildscript voor uw pakket.
• README.md: Een bestand dat uitlegt wat uw pakket doet.
• LICENSE: Het licentiebestand van uw pakket.

Het installatiescript schrijven

Het bestand setup.py is essentieel voor het definiëren van de metadata en afhankelijkheden van uw pakket. Hier is een eenvoudig voorbeeld:

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

Een README-bestand maken

Het bestand README.md zou een overzicht van uw pakket moeten geven, inclusief hoe u het kunt installeren en gebruiken. Hier is een voorbeeld:

# Your Package

A brief description of your package.

Installatie

pip install your_package

Gebruik

import your_package

# Example usage

Het pakket samenstellen

Navigeer naar uw projectmap en voer de volgende opdracht uit om uw pakket te bouwen:

python setup.py sdist bdist_wheel

Met deze opdracht worden distributiearchieven gemaakt in de map dist/.

Publiceren naar PyPI

Om uw pakket te publiceren, hebt u een account op PyPI nodig. Als u er geen hebt, maak deze dan aan op PyPI.

Installeer vervolgens het twine-pakket:

pip install twine

Gebruik twine om uw pakket naar PyPI te uploaden:

twine upload dist/*

U wordt gevraagd om uw PyPI-gebruikersnaam en wachtwoord. Na een succesvolle upload is uw pakket beschikbaar op PyPI.

Conclusie

Gefeliciteerd! U hebt nu uw Python-pakket gemaakt en gepubliceerd. Anderen kunnen het installeren met pip en u kunt het blijven updaten en verbeteren. Vergeet niet om uw pakket te onderhouden door het versienummer bij te werken en nieuwe releases te uploaden terwijl u wijzigingen aanbrengt.