Rozjeď svůj balíček tak, že převedeš skripty, které už máš napsané. Vytvoříš jednoduchý balíček, který budeš moct používat na vlastním počítači.

Začínáme tvořit balíček

Moduly, balíčky a subbalíčky

Ze skriptu k balíčku

Využij svůj balíček v praxi

Dokumentace

Psaní dokumentace funkcí pomocí pymentu

Psaní dokumentace funkcí pomocí pyment II

Dokumentace balíčku a modulů

Strukturování importů

Importy mezi moduly

Import z nadřazených modulů

Zpřístupnění funkcí uživatelům

Od volného kódu k lokálnímu balíčku

Připrav svůj balíček k instalaci – pro sebe i pro ostatní. V této kapitole se naučíš pracovat se závislostmi, psát README soubory a přidávat licence. Projdeš také všechny kroky potřebné k publikování balíčku na PyPI – hlavním místě pro Python balíčky.

Instalace vlastního balíčku

Přidání instalačního skriptu

Lokální instalace balíčku

Využití editovatelných instalací

Práce se závislostmi

Závislosti pro uživatele

Vývojové závislosti

Licence a soubory README

Psaní README

MANIFEST – přidání dalších souborů do balíčku

Publikování balíčku

Sestavení distribuce

Nahrání distribucí

Instaluj svůj balíček odkudkoli

Posuň svůj balíček na profesionální úroveň. Zjistíš, jak používat pytest k odhalování chyb, tox k testování kompatibility s různými verzemi Pythonu a flake8 k udržování čistého stylu kódu.

Testování balíčku

from impyrial.length.core import inches_to_feet, inches_to_yards


Vytvoření testovacího adresáře

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


Píšeme základní testy

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


Spouštění testů

Testování balíčku v různých prostředích

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Nastavení tox

[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.*",
)


Spuštění tox

Udržuj svůj balíček ve stylu

Vhodné filtrování stylu

"""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


Úprava souboru pomocí flake8

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


Ignorování konkrétních chyb

[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/*


Konfigurace flake8

Zvyšování kvality balíčku

Vytvárej balíčky rychleji. V této závěrečné kapitole se naučíš používat cookiecutter k automatickému generování podpůrných souborů, Makefiles ke zjednodušení vydávání nových verzí a seznámíš se s posledními soubory, které balíčku pomůžou přilákat uživatele i přispěvatele.

Rychlejší vývoj balíčků pomocí šablon

Použití šablon balíčků

Čísla verzí a historie

CONTRIBUTING.md

Soubor HISTORY

Sledování čísla verze pomocí bumpversion

Makefile a klasifikátory

Klasifikátory PyPI

Používání Makefile

Závěr

Rychlý vývoj balíčků

Kopíruješ stále stejný kód mezi soubory a přeješ si, aby bylo snazší ho znovu používat a sdílet? Řešením jsou Python balíčky! V tomto kurzu se naučíš, jak jsou balíčky strukturované a jaké soubory potřebuješ, abys z volně napsaného kódu vytvořil/a praktický balíček. Zjistíš také, jak fungují importy, jak psát dokumentaci a jak udržovat čistý styl kódu pomocí flake8. Pak zrychlíš vývoj díky šablonám a nástroji cookiecutter, který ti vygeneruje základní strukturu balíčku. Na závěr se naučíš, jak pomocí setuptools a twine sestavit balíček a publikovat ho na PyPI – hlavním místě pro sdílení Python balíčků.

Introduction to Shell

Writing Functions in Python

Naučte se strukturu balíčků, importy, dokumentaci a udržování stylu kódu, pak publikujte šablony.

Developing Python Packages

Vytvářejte vlastní balíčky Python, aby se váš kód snadněji používal a sdílel s ostatními.

Nastavení tox

Developing Python Packages

Interaktivní praktické cvičení