Inclure des licences et rédiger des README

Créer des paquetages Python

James Fulton

Climate informatics researcher

Pourquoi ai-je besoin d'une licence ?

  • Accorder aux autres la permission d'utiliser votre code
Créer des paquetages Python

Licences libres

  • Plus d'information ici
  • Autoriser les utilisateurs à
    • utiliser votre paquet
    • modifier votre paquet
    • distribuer des versions de votre paquet
1 https://choosealicense.com
Créer des paquetages Python

Qu'est-ce qu'un README ?

  • La « page d'accueil » de votre paquet
  • Affiché sur GitHub ou PyPI
Créer des paquetages Python

Que mettre dans un README

Sections d'un README

  • Titre
  • Description et fonctionnalités
  • Installation
  • Exemples d'utilisation
  • Contribution
  • Licence
Créer des paquetages Python

Format du README

Markdown (commonmark)

  • Dans le fichier README.md
  • Plus simple
  • Utilisé dans ce cours et dans la nature
reStructuredText

  • Dans le fichier README.rst
  • Plus complexe
  • Aussi courant dans la nature
Créer des paquetages Python

Commonmark

Contenu de README.md














`

Rendu final à l'affichage

Créer des paquetages Python

Commonmark

Contenu de README.md

# mysklearn

mysklearn est un paquet pour la
**régression linéaire** complète en Python.


Pour en savoir plus sur ce paquet,
consultez [DataCamp](https://datacamp.com)

Rendu final à l'affichage

mysklearn

mysklearn est un paquet pour la régression linéaire complète en python.

Pour en savoir plus sur ce paquet, consultez DataCamp

Créer des paquetages Python

Commonmark

Contenu de README.md

# mysklearn

mysklearn est un paquet pour la
**régression linéaire** complète en Python.


Pour en savoir plus sur ce paquet,
consultez [DataCamp](https://datacamp.com)


## Installation
Vous pouvez installer ce paquet avec

Rendu final à l'affichage

mysklearn

mysklearn est un paquet pour la régression linéaire complète en python.

Pour en savoir plus sur ce paquet, consultez DataCamp

Installation

Vous pouvez installer ce paquet avec

Créer des paquetages Python

Commonmark

Contenu de README.md

# mysklearn
mysklearn est un paquet pour la
**régression linéaire** complète en Python.

Pour en savoir plus sur ce paquet,
consultez [DataCamp](https://datacamp.com)

## Installation
Vous pouvez installer ce paquet avec

```
pip install mysklearn
```

Rendu final à l'affichage

mysklearn

mysklearn est un paquet pour la régression linéaire complète en python.

Pour en savoir plus sur ce paquet, consultez DataCamp

Installation

Vous pouvez installer ce paquet avec

pip install mysklearn
Créer des paquetages Python

Ajouter ces fichiers à votre paquet

Arborescence d'un paquet avec des sous-paquets

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- nouveaux fichiers
|-- README.md    <--- ajouté à la racine
Créer des paquetages Python

MANIFEST.in

Dresse la liste des fichiers supplémentaires à inclure dans la distribution de votre paquet.

Créer des paquetages Python

MANIFEST.in

Contenu de MANIFEST.in

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---
Créer des paquetages Python

Passons à la pratique !

Créer des paquetages Python

Preparing Video For Download...