Installer votre propre paquet

Créer des paquetages Python

James Fulton

Climate informatics researcher

Pourquoi installer votre propre paquet ?

Dans example_script.py

import mysklearn

Arborescence d'un paquet avec des sous-paquets

home/
|-- mysklearn            <-- dans le même répertoire
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- dans le même répertoire

Pourquoi installer votre propre paquet ?

Dans example_script.py

import mysklearn

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'mysklearn'

Arborescence

home/
|-- mypackages
|   |-- mysklearn     <---
|       |-- __init__.py
|       |-- preprocessing
|       |   |-- __init__.py
|       |   |-- normalize.py
|       |   |-- standardize.py
|       |-- regression
|           |-- __init__.py
|           |-- regression.py
`-- myscripts
    `-- example_script.py     <---

setup.py

Sert à installer le paquet
Contient les métadonnées du paquet

Structure du répertoire du paquet

Arborescence d'un paquet avec des sous-paquets


    mysklearn/
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Structure du répertoire du paquet

Arborescence d'un paquet avec des sous-paquets

mysklearn/      <-- répertoire externe
|-- mysklearn   <--- répertoire interne du code source
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Structure du répertoire du paquet

Arborescence d'un paquet avec des sous-paquets

mysklearn/      <-- répertoire externe
|-- mysklearn   <--- répertoire interne du code source
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- script d'installation dans l'externe

Dans setup.py

# Import required functions
from setuptools import setup


# Call setup function
setup(

    author="James Fulton",

    description="A complete package for linear regression.",

    name="mysklearn",

    version="0.1.0",

)

numéro de version = (numéro majeur) . (numéro mineur) . (correctif)

Dans setup.py

# Import required functions
from setuptools import setup, find_packages

# Call setup function
setup(
    author="James Fulton",
    description="A complete package for linear regression.",
    name="mysklearn",
    version="0.1.0",

    packages=find_packages(include=["mysklearn", "mysklearn.*"]),

)

Installation modifiable (editable)

pip install -e .

. = paquet dans le répertoire courant
-e = modifiable

Arborescence d'un paquet avec des sous-paquets

mysklearn/  <-- se placer ici
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py

Passons à la pratique !

Créer des paquetages Python