Lag og distribuer din egen Python-pakke

Alt begynner med spørsmålet om hvordan du kan lage og effektivt distribuere dine egne Python-pakker. I denne veiledningen viser jeg deg hvordan du går frem steg for steg for å utvikle en pakke som du kan gjøre tilgjengelig for andre. Det er avgjørende å opprette de riktige filene og sørge for riktig oppsett. Dette gjør det enkelt for andre å installere og bruke pakken din. La oss dykke rett inn og utforske grunnleggende om pakke-distribusjon.

Viktigste funn

1. Lag en setup.py-fil som inneholder alle metadataene for pakken din.
2. Legg til en manifestfil som lister opp alle ikke-Python-filer.
3. Bruk riktig kommando i terminalen for å lage distribusjonen din.
4. Den utpakkede pakken kan enkelt overføres for installasjon.

Steg-for-steg guide

Det er noen avgjørende trinn du må følge for å lage din egen Python-pakke. Nedenfor finner du en detaljert veiledning med skjermbilder som viser deg veien til din egen pakke-distribusjon.

Lage mappestrukturen

Først bør du forberede riktig mappestruktur for pakken din. Opprett en hovedmappe som inneholder alle filer og undermapper, inkludert kildekode, dokumentasjon og lisensinformasjon.

I dette eksemplet forbereder jeg en enkel struktur med en README.md-fil og en lisensfil. Du kan bruke GPL-lisens for å fastslå rettighetene dine til pakken.

Definere API-strukturen

For å gjøre pakken din nyttig trenger du minst en API-dokumentasjon og en basis klasse som andre klasser kan arve fra. Denne strukturen hjelper til med å muliggjøre utvidelser og tilpasninger av pakken din.

En enkel API- og lagerklasse kan gi en utmerket inngang.

Opprette setup.py-filen

En sentral komponent i pakken din er setup.py-filen. Her definerer du all nødvendig prosjektinformasjon som trengs under installasjonsprosessen.

I denne filen importerer du nødvendige moduler og angir de grunnleggende detaljene for pakken din, inkludert navn, forfatter, e-post, versjonsnummer og nettsted.

Angi nødvendige pakker

Du må sørge for at alle avhengigheter for pakken din er angitt. Dette skjer i setup.py ved å legge til en liste over pakker som skal følge med pakken din.

Legg til alle nødvendige underpakker her, for eksempel basis klassen og spesifikke omfattende klasser.

Opprette en manifestfil

For å sikre at alle relevante non-Python-filer inkluderes i pakken din, lag en manifestfil. Denne filen lister opp alle filene som skal vurderes under pakking.

I denne filen angir du hvilke filtyper som skal inkluderes i pakken, samt kataloger som for eksempel dokumentasjonen.

Terminal kommandoer for å opprette distribusjonen

Nå er det på tide å opprette pakken. Åpne terminalen din og naviger til katalogen til setup.py. Her kan du utføre kommandoen for å opprette pakken.

Kontrollere de opprettede filene

Etter å ha opprettet distribusjonen, bør du finne en katalog som heter dist som inneholder den pakket pakken.

Du kan nå overføre eller installere denne filen.

Installere pakken

For å sikre at pakken fungerer korrekt, kan du installere den selv. For å gjøre dette må du pakke ut katalogen og kjøre setup.py-filen på nytt.

For brukere uten administratorrettigheter kan du kjøre installasjonskommandoen for den nåværende brukeren:

python setup.py install --user

Distribusjon for brukerne

Hvis du ønsker å distribuere pakken din, må du sørge for at alle filer som README.md, lisens og setup.py er vedlagt. Dette sikrer at pakken kan installeres korrekt så snart brukeren latter ned den.

Her er pakken din klar på filsystemet og kan deles med andre.

Sammendrag – Pakk Python-pakkene dine riktig

Du har nå lært hvordan du kan opprette en omfattende struktur for Python-pakkene dine og effektivt generere en distribusjon enkelt. Fra oppretting av mappestrukturen til installasjon av sluttbrukeren, har du gått gjennom alle trinnene for å effektivt distribuere din egen pakke.