Sådan opretter du en Python-pakke og udgiver den

Oprettelse og udgivelse af en Python-pakke giver dig mulighed for at dele din kode med det bredere Python-fællesskab. I denne vejledning gennemgår vi trinene til at oprette en Python-pakke og udgive den til Python Package Index (PyPI), hvor andre nemt kan installere og bruge den.

Opsætning af dit projekt

Før du starter, skal du sørge for, at du har Python installeret på dit system. Du skal også installere pakkerne setuptools og wheel, hvis du ikke allerede har:

pip install setuptools wheel

Oprettelse af pakkestrukturen

Opret en ny mappe til dit pakkeprojekt. Inde i denne mappe skal du oprette 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 oversigt over disse filer:

• your_package/__init__.py: Markerer mappen som en Python-pakke.
• din_pakke/modul1.py og din_pakke/modul2.py: Dine pakkemoduler.
• tests/: Directory for din pakkes testcases.
• setup.py: Byggescriptet til din pakke.
• README.md: En fil, der forklarer, hvad din pakke gør.
• LICENS: Din pakkes licensfil.

Skrivning af opsætningsscriptet

setup.py-filen er vigtig for at definere din pakkes metadata og afhængigheder. Her er et grundlæggende 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',
)

Oprettelse af en README-fil

Filen README.md skal give et overblik over din pakke, inklusive hvordan den installeres og bruges. Her er et eksempel:

# Your Package

A brief description of your package.

Installation

pip install your_package

Brug

import your_package

# Example usage

Opbygning af pakken

Naviger til din projektmappe og kør følgende kommando for at bygge din pakke:

python setup.py sdist bdist_wheel

Denne kommando opretter distributionsarkiver i mappen dist/.

Udgivelse til PyPI

For at udgive din pakke skal du have en konto på PyPI. Hvis du ikke har en, skal du oprette den på PyPI.

Installer derefter twine-pakken:

pip install twine

Brug twine til at uploade din pakke til PyPI:

twine upload dist/*

Du bliver bedt om dit PyPI-brugernavn og -adgangskode. Efter en vellykket upload vil din pakke være tilgængelig på PyPI.

Konklusion

Tillykke! Du har nu oprettet og udgivet din Python-pakke. Andre kan installere det ved hjælp af pip, og du kan fortsætte med at opdatere og forbedre det. Husk at vedligeholde din pakke ved at opdatere versionsnummeret og uploade nye udgivelser, efterhånden som du foretager ændringer.