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

Ajout du script de configuration

Installer votre package en local

Utiliser les installations modifiables

Gérer les dépendances

Dépendances utilisateur

Dépendances de développement

Ajouter des licences et rédiger des READMEs

Rédiger un README

MANIFEST - Inclure des fichiers supplémentaires avec votre package

Publier votre package

Créer une distribution

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

# Run this script to create package template
# After running you will still need to type in the terminal to specify the template options
cookiecutter https://github.com/audreyfeldroy/cookiecutter-pypackage.git


Utiliser des modèles de package

Numéros de version et historique

CONTRIBUTING.md

# History

## ____
### _____
____
### ____
____

## 0.1.0
### Added
- First release on PyPI.


# History

## 0.2.0
### Fixed
- Bug fixed in `length` subpackage for inches-to-feet conversion.
### Deprecated
- Removed Python 2.7 support.

## 0.1.0
### Added
- First release on PyPI.


Fichier d’historique

#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
	history = history_file.read()

setup(
	author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 2',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    keywords='impyrial',    
    zip_safe=False,
)


__doc__ = """
impyrial
========
A package for converting between imperial measurments of length and weight.
"""

__author__ = "All credit to you"
__version__ = '0.1.0'

from . import length  # noqa : F401
from . import weight  # noqa : F401


# Copy and run this command in the terminal to increase the minor package number
bumpversion minor


Suivi de la version avec bumpversion

Makefiles et classificateurs

#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
    history = history_file.read()

setup(
    author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    long_description_content_type='text/markdown',
    keywords='impyrial',    
    zip_safe=False,
)


#!/usr/bin/env python

"""The setup script."""

from setuptools import setup, find_packages

with open('README.md') as readme_file:
    readme = readme_file.read()

with open('HISTORY.md') as history_file:
    history = history_file.read()

setup(
    author="All credit to you",
    author_email='you@chapter4.com',
    description="A package for converting between imperial unit lengths and weights.",
    name='impyrial',
    packages=find_packages(include=['impyrial', 'impyrial.*']),
    version='0.1.0',
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.6.*",
    classifiers=[
        'Development Status :: 2 - Pre-Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Natural Language :: English',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
    ],
    license="MIT license",
    long_description=readme + '\n\n' + history,
    long_description_content_type='text/markdown',
    keywords='impyrial',    
    zip_safe=False,
)


Classifiers PyPI

# Run this file to complete the exercise 

# Remove old distributions
make clean

# Run tests
make test

# Make new source and wheel distributions
make dist


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.

CONTRIBUTING.md

Exercice interactif pratique