Allt börjar med frågan hur du kan skapa och effektivt distribuera dina egna Python-paket. I denna guide visar jag dig hur du steg för steg går tillväga för att utveckla ett paket som du kan göra tillgängligt för andra. Det är avgörande att skapa de rätta filerna och säkerställa den korrekta strukturen. Detta gör det enkelt för andra att installera och använda ditt paket. Låt oss dyka rakt in och utforska grunderna i paketdistribution.
Viktigaste insikter
- Skapa en setup.py-fil som innehåller all metadata för ditt paket.
- Lägg till en manifestfil som listar alla icke-Python-filer.
- Använd rätt kommando i terminalen för att skapa din distribution.
- Det dekomprimerade paketet kan enkelt överlämnas för installation.
Steg-för-steg-guide
Det finns några avgörande steg som du måste följa för att skapa ditt eget Python-paket. Nedan hittar du en detaljerad guide med skärmdumpar som visar dig vägen till din egen paketdistribution.
Skapa mappstrukturen
Först bör du förbereda den rätta mappstrukturen för ditt paket. Skapa en huvudmapp som innehåller alla filer och undermappar, inklusive källkod, dokumentation och licensinformation.
I detta exempel förbereder jag en enkel struktur med en README.md-fil och en licensfil. Du kan använda GPL-licensen för att fastställa rättigheterna för ditt paket.
Definiera API-strukturen
För att göra ditt paket användbart behöver du åtminstone en API-dokumentation och en basklass som andra klasser kan ärva från. Denna struktur hjälper till att möjliggöra utvidgningar och anpassningar av ditt paket.
En enkel API- och lagringsklass skulle kunna erbjuda en utmärkt början.
Skapa setup.py-filen
En central komponent i ditt paket är setup.py-filen. Här definierar du all nödvändig projektinformation som behövs under installationsprocessen.
I denna fil importerar du de nödvändiga modulerna och anger de grundläggande detaljerna för ditt paket, inklusive namn, författare, e-post, version och webbplats.
Ange nödvändiga paket
Du måste se till att alla beroenden för ditt paket anges. Detta görs i setup.py genom att du lägger till en lista över paket som ska levereras tillsammans med ditt paket.
Lägg till alla nödvändiga underpaket här, till exempel basklassen och specifika omfattande klasser.
Skapa en manifestfil
För att säkerställa att alla relevanta icke-Python-filer inkluderas i ditt paket, skapa en manifestfil. Denna fil listar alla filer som ska beaktas vid paketering.
I denna fil anger du vilka filtyper som ska inkluderas i paketet, samt kataloger som dokumentationen.
Terminalkommandon för att skapa distributionen
Nu är det dags att skapa paketet. Öppna din terminal och navigera till katalogen för din setup.py. Här kan du köra kommandot för att skapa paketet.
Kontrollera de skapade filerna
Efter att ha skapat distributionen bör du hitta en katalog som heter dist som innehåller det packade paketet.
Du kan nu överlämna eller installera denna fil.
Installation av paketet
För att säkerställa att paketet fungerar korrekt kan du själv installera det igen. För detta packar du upp katalogen och kör setup.py-filen på nytt.
För användare som inte har administratörsrättigheter kan du köra installationskommandot för den aktuella användaren:
Distribution för användarna
Om du vill distribuera ditt paket, se till att alla filer som README.md, licens och setup.py är bifogade. Detta säkerställer att paketet kan installeras korrekt så snart användaren laddar ner det.
Här är ditt paket redo på filsystemet och kan ges till andra.
Sammanfattning – Packa dina Python-paket korrekt
Du har nu lärt dig hur du skapar en omfattande struktur för dina Python-paket och framgångsrikt genererar en distribution som du enkelt kan distribuera. Från skapandet av mappstrukturen till installationen av slutkunden har du gått igenom alla steg för att effektivt distribuera ditt eget paket.
Vanliga frågor
Hur skapar jag manifestfilen?Du kan manuellt skapa manifestfilen och ange de filer som ditt paket ska innehålla.
Vad måste jag lägga till i setup.py-filen?setup.py-filen bör innehålla paketnamn, författare, e-postadress, versionsnummer och alla nödvändiga beroenden.
Hur installerar jag paketet efter skapandet?Du kan installera paketet lokalt genom att navigera till din paketkatalog i terminalen och köra kommandot python setup.py install.
Vilken licens bör jag välja för mitt paket?GNU GPL-licensen väljs ofta för att skydda fri programvara och dess källkod. Du kan dock också överväga andra licenser.
Kan jag också publicera mitt paket på PyPI?Ja, du kan publicera ditt paket på Python Package Index (PyPI) för att göra det tillgängligt för allmänheten.
