Guida ai Python package di pyOpenSci

Supportiamo gli strumenti Python di cui gli scienziati hanno bisogno per creare flussi di lavoro di scienza aperta.

Informazioni su questa guida

Questa guida ti aiuterà a:

1. Imparare a creare un Python package dall’inizio alla fine

2. Comprendere l’ecosistema più ampio degli strumenti di Python packaging

3. Orientarti e prendere decisioni riguardo alle opzioni degli strumenti

4. Comprendere tutti gli aspetti della creazione e della manutenzione di un Python package

Troverai inoltre raccomandazioni sulle migliori pratiche ed elenchi curati di risorse della comunità relative al packaging e alla documentazione dei package.

Serie di tutorial: crea un Python package

Il primo ciclo della nostra serie di tutorial per scienziati su come creare un Python package, sviluppata dalla comunità, è completo! Partecipa al nostro processo di revisione della comunità o segui lo sviluppo dei tutorial futuri nel nostro repository GitHub qui.

✿ Tutorial per creare un package ✿

• Cos’è un Python package?

• Crea un Python package

• Pubblica il tuo package su (test) PyPI

• Pubblica il tuo package su conda-forge

✿ Tutorial sui metadati del package ✿

• Come aggiungere un file README

• Come aggiungere metadati a un file pyproject.toml per la pubblicazione su PyPI.

✿ Tutorial sugli strumenti di packaging ✿

• Introduzione a Hatch

• Esegui script Python usando Hatch

✿ Guide di riferimento ✿

• Guida di riferimento della riga di comando

Python packaging per scienziati

Scopri le migliori pratiche per il Python packaging. Conoscerai inoltre il ricco ecosistema di strumenti di packaging disponibili per aiutarti nelle tue esigenze di Python packaging.

✨ Crea il tuo package ✨

• Struttura dei file del package

• Metadati del package / pyproject.toml

• Crea il tuo Python package (sdist / wheel)

• Dichiara le dipendenze

• Orientarsi nell’ecosistema degli strumenti di packaging

• Build di Python package non puri

✨ Pubblica il tuo package ✨

Approfondisci la tua conoscenza dell’ecosistema del Python packaging. Scopri le migliori pratiche per:

• Versionamento e rilascio del package

• Pubblica su PyPI e Conda-forge

Documentazione

✨ Scrivi la tua documentazione ✨

• Crea la documentazione per i tuoi utenti

• File essenziali da includere nel repository del package

• Scrivi tutorial per mostrare come si usa il tuo package

✨ Documentazione per sviluppatori ✨

• Crea documentazione per gli sviluppatori collaboratori

• Scrivi una guida allo sviluppo

✨ Crea documentazione per una comunità ✨

• Scrivere un file README

• Stabilisci delle norme con un Codice di Condotta

• Aggiungi una licenza al tuo Python package

✨ Pubblica la tua documentazione ✨

• Come pubblicare la tua documentazione

• Usare Sphinx

• Markdown, MyST e ReST

• Ospita la tua documentazione su Read The Docs o GitHub Pages

Test

✨ Test per il tuo Python package ✨

• Introduzione ai test

• Scrivi i test

• Tipi di test

✨ Esegui i tuoi test ✨

• Esegui i test in locale con Hatch

• Esegui i test con nox

• Esegui i test in CI

Contribuire

✨ Stile e formattazione del codice ✨

• Stile del codice

✨ Vuoi contribuire? ✨

Accogliamo con piacere i contributi a questa guida. Scopri di più su come puoi contribuire.

Contribuire alla Python Packaging Guide

Una guida creata dalla comunità

Ogni pagina di questa guida passa attraverso un approfondito processo di revisione della comunità. Per garantire che la nostra guida sia accurata e adatta ai principianti, incoraggiamo le revisioni da parte di un insieme eterogeneo di pythonisti e scienziati con un’ampia gamma di competenze ed esperienze.

Visualizza i contributori della guida

A chi è rivolta questa guida

Questa guida è rivolta a chiunque sia interessato ad approfondire il Python packaging. È adatta ai principianti e fornirà:

1. Una guida completa, dall’inizio alla fine, sulla creazione di un Python package.

2. Risorse per aiutarti a orientarti nell’ecosistema di strumenti e approcci del Python packaging.

3. Un elenco curato di risorse per aiutarti a rendere il tuo package documentato, utilizzabile e manutenibile.

Dove è diretta questa guida

Se hai idee su aspetti che vorresti vedere chiariti in questa guida, ti invitiamo ad aprire una issue su GitHub..

Se hai domande sul nostro processo di revisione tra pari o sul packaging in generale, ti invitiamo a utilizzare le nostre Discussioni GitHub.

Questa guida sul Python packaging viene aggiornata continuamente man mano che gli strumenti e le migliori pratiche si evolvono nell’ecosistema del Python packaging. Aggiungeremo nuovi contenuti nel corso del prossimo anno.