Includere le licenze e scrivere i README

Sviluppare pacchetti Python

James Fulton

Climate informatics researcher

Perché mi serve una licenza?

Per dare ad altri il permesso di usare il tuo codice

Licenze open source

Trova più informazioni qui
Consenti agli utenti di
- usare il tuo package
- modificare il tuo package
- distribuire versioni del tuo package

¹ https://choosealicense.com

Che cos'è un README?

La "prima pagina" del tuo package
Mostrato su Github o PyPI

Cosa includere in un README

Sezioni del README

Titolo
Descrizione e funzionalità
Installazione
Esempi d'uso
Contributi
Licenza

Formato del README

Markdown (commonmark)

Nel file README.md
Più semplice
Usato in questo corso e in giro

reStructuredText

Nel file README.rst
Più complesso
Anch'esso comune in giro

Commonmark

Contenuti di README.md

Come appare una volta renderizzato

Commonmark

Contenuti di README.md

# mysklearn

mysklearn è un package per la 
**regressione lineare** completa in Python.


Puoi saperne di più su questo package 
su [DataCamp](https://datacamp.com)

Come appare una volta renderizzato

mysklearn

mysklearn è un package per la regressione lineare in python.

Puoi saperne di più su questo package su DataCamp

Commonmark

Contenuti di README.md

# mysklearn

mysklearn è un package per la 
**regressione lineare** completa in Python.


Puoi saperne di più su questo package 
su [DataCamp](https://datacamp.com)


## Installazione
Puoi installare questo package usando

Come appare una volta renderizzato

mysklearn

mysklearn è un package per la regressione lineare in python.

Puoi saperne di più su questo package su DataCamp

Installazione

Puoi installare questo package usando

Commonmark

Contenuti di README.md

# mysklearn
mysklearn è un package per la 
**regressione lineare** completa in Python.

Puoi saperne di più su questo package 
su [DataCamp](https://datacamp.com)

## Installazione
Puoi installare questo package usando

```
pip install mysklearn
```

Come appare una volta renderizzato

mysklearn

mysklearn è un package per la regressione lineare in python.

Puoi saperne di più su questo package su DataCamp

Installazione

Puoi installare questo package usando

pip install mysklearn

Aggiungere questi file al tuo package

Struttura delle directory per un package con sottopackage

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- nuovi file
|-- README.md    <--- aggiunto alla directory principale

MANIFEST.in

Elenca tutti i file extra da includere nella distribuzione del package.

MANIFEST.in

Contenuto di MANIFEST.in

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---

Esercitiamoci!

Sviluppare pacchetti Python