Opret og distribuer din egen Python-pakke

Alt begynder med spørgsmålet om, hvordan du kan oprette og effektivt distribuere dine egne Python-pakker. I denne vejledning viser jeg dig, hvordan du trin for trin går til værks for at udvikle et pakke, som du kan stille til rådighed for andre. Det er vigtigt at oprette de rigtige filer og sikre den korrekte struktur. Dette giver andre mulighed for nemt at installere og bruge dit pakke. Lad os dykke direkte ind og udforske grundlæggende om pakke distribution.

Vigtigste indsigt

1. Opret en setup.py-fil, der indeholder alle metadata for dit pakke.
2. Tilføj en manifestfil, der lister alle ikke-Python-filer.
3. Brug den rigtige kommando i terminalen for at oprette din distribution.
4. Det udpakkede pakke kan nemt overleveres til installation.

Trin-for-trin vejledning

Der er nogle afgørende trin, som du skal følge for at oprette dit eget Python-pakke. Nedenfor finder du en detaljeret vejledning med screenshots, der viser dig vejen til din egen pakke distribution.

Oprettelse af mappestrukturen

Først skal du forberede den rigtige mappestruktur til dit pakke. Opret en overordnet mappe, der indeholder alle filer og undermapper, herunder kildekode, dokumentation og licensoplysninger.

I dette eksempel forbereder jeg en simpel struktur med en README.md-fil og en licensfil. Du kan bruge GPL-licensen til at fastsætte rettighederne for dit pakke.

Definere API-strukturen

For at gøre dit pakke nyttigt, har du brug for mindst én API-dokumentation og en basis klasse, som andre klasser kan arve fra. Denne struktur hjælper med at muliggøre udvidelser og tilpasninger af dit pakke.

En simpel API- og lagerklasse kunne give en fremragende start.

Oprettelse af setup.py-fil

En central komponent i dit pakke er setup.py-filen. Her definerer du alle nødvendige projektinformationer, der kræves under installationsprocessen.

I denne fil importerer du de nødvendige moduler og angiver de grundlæggende detaljer om dit pakke, herunder navn, forfatter, e-mail, versionsnummer og hjemmeside.

Angive nødvendige pakker

Du skal sørge for, at alle afhængigheder for dit pakke angives. Dette gøres i setup.py, ved at du tilføjer en liste over pakker, der skal leveres med dit pakke.

Tilføj her alle nødvendige underpakker, for eksempel basis klasse og specifikke omfattende klasser.

Oprettelse af manifestfil

For at sikre, at alle relevante non-Python-filer inkluderes i dit pakke, skal du oprette en manifestfil. Denne fil lister alle filer, der tages hensyn til ved pakker.

I denne fil angiver du, hvilke filtyper der skal inkluderes i pakken, samt mapper som for eksempel dokumentationen.

Terminal kommandoer til oprettelse af distribution

Nu er det tid til at oprette pakke. Åbn dit terminal og naviger til mappen for din setup.py. Her kan du køre kommandoen for at oprette pakken.

Kontrol af oprettede filer

Efter oprettelsen af distributionen, bør du finde en mappe kaldet dist, der indeholder den pakkede pakke.

Du kan nu overføre eller installere denne fil.

Installation af pakken

For at sikre, at pakken fungerer korrekt, kan du selv geninstallere den. Du pakker mappen ud og kører setup.py-filen igen.

For brugere, der ikke har administratorrettigheder, kan du køre installationskommandoen for den aktuelle bruger:

python setup.py install --user

Distribution til brugerne

Hvis du vil distribuere dit pakke, skal du sørge for, at alle filer som README.md, licens og setup.py er vedhæftet. Dette sikrer, at pakken kan installeres korrekt, så snart brugeren downloader den.

Her er dit pakke klar på filsystemet og kan gives videre til andre.

Resumé - Pak dine Python-pakker korrekt

Du har nu lært at oprette en omfattende struktur for dine Python-pakker og effektivt generere en distribution, som du let kan distribuere. Fra oprettelsen af mappestrukturen til installationen af slutbrugeren har du gennemgået alle trin for effektivt at distribuere dit eget pakke.