Bring dein Paket an den Start, indem du bereits geschriebene Skripte umwandelst. Du erstellst ein einfaches Paket, das du auf deinem eigenen Computer verwenden kannst.

Ein Paket starten

Module, Pakete und Subpackages

Vom Skript zum Paket

Dein Paket in Aktion

Dokumentation

Funktionsdokumentation mit pyment schreiben

Funktionsdokumentation mit pyment II schreiben

Paket- und Modul­dokumentation

Imports strukturieren

Imports zwischen Geschwistermodulen

Import aus übergeordneten Paketen

Funktionen für Nutzer freigeben

Von losem Code zum lokalen Paket

Mach dein Paket für dich und andere installierbar. In diesem Kapitel lernst du, mit Abhängigkeiten umzugehen, READMEs zu schreiben und Lizenzen einzubinden. Außerdem durchläufst du alle Schritte, um dein Paket auf PyPI zu veröffentlichen – der Hauptplattform für Python-Pakete.

Dein eigenes Paket installieren

Das Setup-Skript hinzufügen

Dein Paket lokal installieren

Editierbare Installationen nutzen

Mit Abhängigkeiten umgehen

Abhängigkeiten deiner Nutzenden

Entwicklungsabhängigkeiten

Lizenzen einbinden und READMEs schreiben

Ein README schreiben

MANIFEST – Zusätzliche Dateien mit deinem Paket einbinden

Dein Paket veröffentlichen

Ein Distribution-Paket bauen

Distributionen hochladen

Installiere dein Paket von überall

Hebe dein Paket auf ein professionelles Niveau. Entdecke, wie du mit pytest Fehlern vorbeugst, mit tox testest, ob dein Paket mit mehreren Python-Versionen funktioniert, und mit flake8 einen sauberen Codestil sicherstellst.

Dein Paket testen

Das Testverzeichnis erstellen

Ein paar grundlegende Tests schreiben

Deine Tests ausführen

Dein Paket in unterschiedlichen Umgebungen testen

tox einrichten

tox ausführen

Dein Paket stilvoll halten

Passendes Style-Filtering

Mit flake8 eine Datei aufräumen

Bestimmte Fehler ignorieren

flake8 konfigurieren

Die Qualität deines Pakets steigern

Erstelle deine Pakete schneller. In diesem letzten Kapitel lernst du, wie du mit cookiecutter alle unterstützenden Dateien für dein Paket erzeugst, mit Makefiles das Veröffentlichen neuer Versionen vereinfachst und welche letzten Dateien dein Paket braucht, um Nutzer:innen und Beitragende zu überzeugen.

Schnelleres Paket-Development mit Vorlagen

# 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


Paketvorlagen verwenden

Versionsnummern und Verlauf

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.


History-Datei

#!/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


Versionsnummer mit bumpversion nachverfolgen

Makefiles und Klassifizierer

#!/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,
)


PyPI-Classifiers

# Run this file to complete the exercise 

# Remove old distributions
make clean

# Run tests
make test

# Make new source and wheel distributions
make dist


Makefiles verwenden

Zusammenfassung

Schnelle Paketentwicklung

Kopierst du denselben Code ständig zwischen Dateien hin und her und wünschst dir, ihn einfacher wiederzuverwenden und zu teilen? Wenn du deinen Code in Python-Pakete packst, geht das! In diesem Kurs lernst du den Paketaufbau kennen und welche zusätzlichen Dateien nötig sind, um losen Code in handliche Pakete zu verwandeln. Außerdem erfährst du, wie du Importe strukturierst, Dokumentation erstellst und mit flake8 einen einheitlichen Codestil beibehältst. Danach beschleunigst du die Paketentwicklung mit Vorlagen und nutzt cookiecutter, um Paketskelette zu erzeugen. Zum Schluss lernst du, wie du mit setuptools und twine deine Pakete baust und auf PyPI veröffentlichst – der zentralen Bühne für Python-Pakete.

Introduction to Shell

Writing Functions in Python

Lerne Paketstruktur, Importstruktur, Dokumentation und Code-Stil. Erstelle Vorlagen und nutze Setuptools.

Python-Pakete entwickeln

Lerne, eigene Python-Pakete zu erstellen, damit dein Code leichter zu nutzen und mit anderen zu teilen ist.

CONTRIBUTING.md

Interaktive praktische Übung