Hur man skapar ett Python-paket och publicerar det

Genom att skapa och publicera ett Python-paket kan du dela din kod med den bredare Python-gemenskapen. I den här guiden går vi igenom stegen för att skapa ett Python-paket och publicera det till Python Package Index (PyPI), där andra enkelt kan installera och använda det.

Konfigurera ditt projekt

Innan du börjar, se till att du har Python installerat på ditt system. Du måste också installera paketen setuptools och wheel om du inte redan har gjort det:

pip install setuptools wheel

Skapa paketstrukturen

Skapa en ny katalog för ditt paketprojekt. Inuti den här katalogen skapar du följande struktur:

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

Här är en kort översikt över dessa filer:

• your_package/__init__.py: Markerar katalogen som ett Python-paket.
• ditt_paket/modul1.py och ditt_paket/modul2.py: Dina paketmoduler.
• tests/: Katalog för ditt pakets testfall.
• setup.py: Byggskriptet för ditt paket.
• README.md: En fil som förklarar vad ditt paket gör.
• LICENS: Ditt pakets licensfil.

Skriver installationsskriptet

Filen setup.py är viktig för att definiera ditt pakets metadata och beroenden. Här är ett grundläggande exempel:

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='[email protected]',
    license='MIT',
)

Skapa en README-fil

Filen README.md bör ge en översikt över ditt paket, inklusive hur du installerar och använder det. Här är ett exempel:

# Your Package

A brief description of your package.

Installation

pip install your_package

Användande

import your_package

# Example usage

Bygger paketet

Navigera till din projektkatalog och kör följande kommando för att bygga ditt paket:

python setup.py sdist bdist_wheel

Detta kommando skapar distributionsarkiv i katalogen dist/.

Publicerar till PyPI

För att publicera ditt paket behöver du ett konto på PyPI. Om du inte har en, skapa den på PyPI.

Installera sedan twine-paketet:

pip install twine

Använd twine för att ladda upp ditt paket till PyPI:

twine upload dist/*

Du kommer att bli ombedd att ange ditt PyPI-användarnamn och lösenord. Efter en lyckad uppladdning kommer ditt paket att vara tillgängligt på PyPI.

Slutsats

Grattis! Du har nu skapat och publicerat ditt Python-paket. Andra kan installera det med pip, och du kan fortsätta att uppdatera och förbättra det. Tänk på att underhålla ditt paket genom att uppdatera versionsnumret och ladda upp nya utgåvor när du gör ändringar.