Hvordan lage en Python-pakke og publisere den

Ved å lage og publisere en Python-pakke kan du dele koden din med det bredere Python-fellesskapet. I denne veiledningen går vi gjennom trinnene for å lage en Python-pakke og publisere den til Python Package Index (PyPI), der andre enkelt kan installere og bruke den.

Sette opp prosjektet ditt

Før du starter, sørg for at du har Python installert på systemet ditt. Du må også installere pakkene setuptools og wheel hvis du ikke allerede har:

pip install setuptools wheel

Opprette pakkestrukturen

Opprett en ny katalog for pakkeprosjektet ditt. Inne i denne katalogen oppretter du følgende struktur:

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

Her er en kort oversikt over disse filene:

• your_package/__init__.py: Merker katalogen som en Python-pakke.
• your_package/module1.py og your_package/module2.py: Pakkemodulene dine.
• tests/: Katalog for pakkens testtilfeller.
• setup.py: Byggeskriptet for pakken din.
• README.md: En fil som forklarer hva pakken din gjør.
• LISENS: Pakkens lisensfil.

Skrive oppsettskriptet

setup.py-filen er viktig for å definere pakkens metadata og avhengigheter. Her er et grunnleggende eksempel:

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',
)

Opprette en README-fil

README.md-filen skal gi en oversikt over pakken din, inkludert hvordan du installerer og bruker den. Her er et eksempel:

# Your Package

A brief description of your package.

Installasjon

pip install your_package

Bruk

import your_package

# Example usage

Bygge pakken

Naviger til prosjektkatalogen din og kjør følgende kommando for å bygge pakken din:

python setup.py sdist bdist_wheel

Denne kommandoen oppretter distribusjonsarkiver i dist/-katalogen.

Publiserer til PyPI

For å publisere pakken din trenger du en konto på PyPI. Hvis du ikke har en, lag den på PyPI.

Installer deretter twine-pakken:

pip install twine

Bruk twine for å laste opp pakken til PyPI:

twine upload dist/*

Du vil bli bedt om ditt PyPI-brukernavn og passord. Etter en vellykket opplasting vil pakken din være tilgjengelig på PyPI.

Konklusjon

Gratulerer! Du har nå opprettet og publisert Python-pakken. Andre kan installere det ved å bruke pip, og du kan fortsette å oppdatere og forbedre det. Husk å vedlikeholde pakken din ved å oppdatere versjonsnummeret og laste opp nye utgivelser etter hvert som du gjør endringer.