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

from impyrial.length.core import inches_to_feet, inches_to_yards


Das Testverzeichnis erstellen

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def ____():
	# Check that 12 inches is converted to 1.0 foot
    ____ ____(____) == 1.0 
    # Check that 2.5 feet is converted to 30.0 inches
    ____ ____(____, reverse=True) == ____


from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1.0 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30.0 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0


Ein paar grundlegende Tests schreiben

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0
    


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 120  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


Deine Tests ausführen

Dein Paket in unterschiedlichen Umgebungen testen

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


tox einrichten

[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest
    


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'],
    #python_requires="==____.*",
)


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'],
    python_requires="==3.9.*",
)


tox ausführen

Dein Paket stilvoll halten

Passendes Style-Filtering

"""Main module."""

def absolute_value(num):
    """Return the absolute value of the number"""
    if num>=0: return num
    else:
    	return -num


"""Main module."""


def absolute_value(num):
    """Return the absolute value of the number"""
    if num >= 0:
        return num
    else:
        return -num


Mit flake8 eine Datei aufräumen

import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # ____: ____
    return l


import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # noqa: E741
    return l


Bestimmte Fehler ignorieren

[flake8]

# Ignore F401 violations in the main __init__.py file
# per-file-ignores =
#     ____ : ____
        
# Ignore all violations in the tests directoory
# exclude = ____


from impyrial.length.api import (
    convert_unit,
    unit_to_mixed,
    mixed_to_unit,
)

def test_convert_unit():
    assert convert_unit(30, "ft", "in")==360.0
    assert convert_unit(30, "yd", "ft")==90.0
    assert convert_unit(10, "mi", "yd")==17600.0


[flake8]

# Ignore F401 violations in the main __init__.py file
per-file-ignores =
    impyrial/__init__.py: F401
        
# Ignore all violations in the tests directoory
exclude = tests/*


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

Paketvorlagen verwenden

Versionsnummern und Verlauf

CONTRIBUTING.md

History-Datei

Versionsnummer mit bumpversion nachverfolgen

Makefiles und Klassifizierer

PyPI-Classifiers

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.

flake8 konfigurieren

Interaktive praktische Übung