Maak en verspreid je eigen Python-pakket

Alles begint met de vraag hoe je je eigen Python-pakketten gaat maken en effectief verdeelt. In deze gids laat ik je stap voor stap zien hoe je een pakket ontwikkelt dat je aan anderen ter beschikking kunt stellen. Het is daarbij essentieel om de juiste bestanden aan te maken en de correcte opbouw te waarborgen. Dit stelt anderen in staat om je pakket eenvoudig te installeren en te gebruiken. Laten we direct aan de slag gaan en de basisprincipes van pakketdistributie verkennen.

Belangrijkste inzichten

1. Maak een setup.py-bestand dat alle metadata van je pakket bevat.
2. Voeg een manifestbestand toe dat alle niet-Python-bestanden opsomt.
3. Gebruik het juiste commando in de terminal om je distributie te maken.
4. Het uitgepakte pakket kan eenvoudig voor installatie worden doorgegeven.

Stap-voor-stap handleiding

Er zijn enkele cruciale stappen die je moet volgen om je eigen Python-pakket te maken. Hieronder vind je een gedetailleerde handleiding met schermafbeeldingen die je de weg naar je eigen pakketdistributie toont.

De directorystructuur maken

Allereerst moet je de juiste directorystructuur voor je pakket voorbereiden. Maak een hoofdmap aan die alle bestanden en subdirectories bevat, zoals broncode, documentatie en licentie-informatie.

In dit voorbeeld bereid ik een eenvoudige structuur voor met een README.md-bestand en een licentiebestand. Je kunt de GPL-licentie gebruiken om de rechten van je pakket vast te leggen.

Definiëren van de API-structuur

Om je pakket nuttig te maken, heb je minimaal een API-documentatie en een basis klasse nodig waarvan andere klassen kunnen erven. Deze structuur helpt bij het mogelijk maken van uitbreidingen en aanpassingen van je pakket.

Een eenvoudige API- en voorraadklasse kan een uitstekende start bieden.

Opstellen van het setup.py-bestand

Een centrale component van je pakket is het setup.py-bestand. Hier definieer je alle noodzakelijke projectinformatie die nodig is tijdens het installatieproces.

In dit bestand importeer je de benodigde modules en geef je de basisgegevens van je pakket op, waaronder naam, auteur, e-mail, versienummer en website.

Opgeven van noodzakelijke pakketten

Je moet ervoor zorgen dat alle afhankelijkheden van je pakket worden opgegeven. Dit gebeurt in de setup.py door een lijst van pakketten toe te voegen die met je pakket geleverd moeten worden.

Voeg hier alle noodzakelijke subpakketten toe, bijvoorbeeld de basis klasse en specifieke uitgebreide klassen.

Aanmaken van een manifestbestand

Om ervoor te zorgen dat alle relevante non-Python-bestanden in je pakket worden opgenomen, maak je een manifestbestand. Dit bestand somt alle bestanden op die bij het verpakken in aanmerking komen.

In dit bestand geef je op welke bestandstypen in het pakket moeten worden opgenomen, evenals directories zoals bijvoorbeeld de documentatie.

Terminalcommando's voor het maken van de distributie

Nu is het tijd om het pakket te maken. Open je terminal en navigeer naar de directory van je setup.py. Hier kun je het commando voor het maken van het pakket uitvoeren.

Controleren van de aangemaakte bestanden

Na het maken van de distributie zou je een map genaamd dist moeten vinden die het verpakte pakket bevat.

Je kunt nu dit bestand doorgeven of installeren.

Installatie van het pakket

Om ervoor te zorgen dat het pakket correct werkt, kun je het zelf opnieuw installeren. Hiervoor pak je de directory uit en voer je de setup.py opnieuw uit.

Voor gebruikers die geen beheerdersrechten hebben, kun je het install commando voor de huidige gebruiker uitvoeren:

python setup.py install --user

Distributie voor de gebruikers

Als je je pakket wilt verdelen, zorg er dan voor dat alle bestanden, zoals README.md, licentie en de setup.py zijn bijgevoegd. Dit zorgt ervoor dat het pakket correct kan worden geïnstalleerd zodra de gebruiker het downloadt.

Hier is je pakket klaar op het bestandssysteem en kan het aan anderen worden doorgegeven.

Samenvatting – Pak je Python-pakketten goed in

Je hebt nu geleerd hoe je een uitgebreide structuur voor je Python-pakketten kunt maken en succesvol een distributie kunt genereren die je eenvoudig kunt verdelen. Van het maken van de directorystructuur tot de installatie door de eindgebruiker, je hebt alle stappen doorlopen om je eigen pakket effectief te verdelen.