Lancez votre package en convertissant des scripts que vous avez déjà écrits. Vous créerez un package simple que vous pourrez utiliser sur votre propre ordinateur.

Démarrer un package

Modules, packages et sous-packages

D’un script à un package

Mettre votre package au travail

Documentation

Rédiger la documentation d’une fonction avec pyment

Rédiger la documentation des fonctions avec pyment II

Documentation de package et de module

Structurer les imports

Imports entre modules frères

Importer depuis les parents

Rendre des fonctions accessibles aux utilisateurs

D’un code épars à un package local

Rendez votre package installable pour vous et pour les autres. Dans ce chapitre, vous apprendrez à gérer les dépendances, à rédiger des README et à inclure des licences. Vous accomplirez aussi toutes les étapes pour publier votre package sur PyPI — le principal hébergement de packages Python.

Installer votre propre package

# Import required functions
____

# Call setup function
____(
    author="<your-name>",
    description="____",
    name="____",
    packages=____(____=____),
    version="____",
)


# Import required functions
from setuptools import setup, find_packages

# Call setup function
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
)


Ajout du script de configuration

import impyrial

result = impyrial.length.convert_unit(10, 'in', 'yd')
print(result)


# Run this to install the package locally
pip install -e .


Installer votre package en local

"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 160  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


import impyrial

result = impyrial.weight.convert_unit(2, 'lb', 'oz')
print(result)


"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 16.0  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


Utiliser les installations modifiables

Gérer les dépendances

from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    ____=____,
)


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
)


Dépendances utilisateur

# Run this script to install the package locally
pip freeze > requirements.txt


Dépendances de développement

Ajouter des licences et rédiger des READMEs

____

A package for converting between imperial unit lengths and weights.

This package was created for the ____DataCamp____ course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

____
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
____


# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


Rédiger un README

# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course Developing Python Packages.

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


MANIFEST - Inclure des fichiers supplémentaires avec votre package

Publier votre package

# Run this code to complete the exercise
python3 setup.py sdist bdist_wheel


Créer une distribution

# Run the following in the terminal:
# twine upload dist/*


Téléverser les distributions

Installer votre package depuis n’importe où

Amenez votre package à un niveau professionnel. Découvrez comment utiliser pytest pour éviter les erreurs, tox pour tester votre package avec plusieurs versions de Python, et flake8 pour maintenir un excellent style de code.

Tester votre package

Créer le répertoire de tests

Écrire des tests de base

Exécuter vos tests

Tester votre package dans différents environnements

Configurer tox

Exécuter tox

Garder votre package élégant

Filtrage de style approprié

Utiliser flake8 pour nettoyer un fichier

Ignorer des erreurs spécifiques

Configurer flake8

Améliorer la qualité de votre package

Créez vos packages plus rapidement. Dans ce dernier chapitre, vous apprendrez à utiliser cookiecutter pour générer tous les fichiers d’accompagnement dont votre package a besoin, des Makefiles pour simplifier la publication de nouvelles versions, et vous découvrirez les derniers fichiers à ajouter pour attirer des utilisateurs et des contributeurs.

Accélérez le développement de vos packages avec des modèles

Utiliser des modèles de package

Numéros de version et historique

CONTRIBUTING.md

Fichier d’historique

Suivi de la version avec bumpversion

Makefiles et classificateurs

Classifiers PyPI

Utiliser des Makefiles

Récapitulatif

Développement rapide de packages

Vous copiez et collez souvent le même code entre plusieurs fichiers et vous aimeriez le réutiliser et le partager plus facilement ? Transformer votre code en packages Python peut vous aider ! Dans ce cours, vous allez découvrir la structure d’un package et les fichiers supplémentaires nécessaires pour convertir du code isolé en packages pratiques. Vous verrez aussi l’organisation des imports, la documentation et comment maintenir un style de code cohérent avec flake8. Vous accélérerez ensuite votre développement en créant des modèles et en utilisant cookiecutter pour générer l’ossature d’un package. Enfin, vous apprendrez à utiliser setuptools et twine pour construire et publier vos packages sur PyPI — la scène mondiale des packages Python.

Introduction to Shell

Writing Functions in Python

Découvrez la structure des paquets, l'importation, la documentation, et maintenez le style du code.

Développer des packages Python

Apprenez à créer vos propres packages Python afin de faciliter l'utilisation de votre code et de le partager avec d'autres.

Installer votre package en local

Développer des packages Python

Exercice interactif pratique