Zacznij budować pakiet, przekształcając skrypty, które już napisałeś. Stworzysz prosty pakiet, z którego będziesz korzystać na własnym komputerze.

Tworzenie pakietu

Moduły, pakiety i podpakiety

Od skryptu do pakietu

Zastosuj swój pakiet w praktyce

Dokumentacja

Tworzenie dokumentacji funkcji za pomocą pyment

Dokumentowanie funkcji za pomocą pyment – część II

Dokumentacja pakietu i modułu

Strukturyzacja importów

Importy między modułami

Importowanie z pakietów nadrzędnych

Udostępnianie funkcji użytkownikom

Od luźnego kodu do lokalnego pakietu

Spraw, by twój pakiet można było zainstalować — zarówno dla siebie, jak i dla innych. W tym rozdziale nauczysz się zarządzać zależnościami, pisać pliki README oraz dodawać licencje. Przejdziesz też przez wszystkie kroki potrzebne do opublikowania pakietu w PyPI — głównym repozytorium pakietów Pythona.

Instalowanie własnego pakietu

Dodawanie skryptu setup

Lokalna instalacja pakietu

Instalacja w trybie edytowalnym

Zarządzanie zależnościami

Zależności użytkownika

Zależności deweloperskie

Dołączanie licencji i pisanie plików README

Pisanie pliku README

MANIFEST – dołączanie dodatkowych plików do pakietu

Publikowanie pakietu

Tworzenie dystrybucji

Przesyłanie dystrybucji

Instalacja pakietu z dowolnego miejsca

Doprowadź swój pakiet do profesjonalnego poziomu. Dowiesz się, jak używać pytest do wykrywania błędów, tox do testowania zgodności pakietu z różnymi wersjami Pythona oraz flake8 do dbania o styl kodu.

Testowanie pakietu

from impyrial.length.core import inches_to_feet, inches_to_yards


Tworzenie katalogu testów

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


Pisanie podstawowych testów

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


Uruchamianie testów

Testowanie pakietu w różnych środowiskach

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


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


Uruchamianie tox

Dbaj o styl swojego pakietu

Odpowiednie filtrowanie 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


Porządkowanie pliku za 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


Ignorowanie wybranych błędów

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


Konfigurowanie flake8

Podnoszenie jakości pakietu

Twórz pakiety szybciej i sprawniej. W tym ostatnim rozdziale nauczysz się używać cookiecutter do generowania wszystkich potrzebnych plików pomocniczych, plików Makefile do upraszczania wydawania nowych wersji. Poznasz też ostatnie pliki, które pomogą przyciągnąć użytkowników i współtwórców do twojego pakietu.

Szybsze tworzenie pakietów dzięki szablonom

Korzystanie z szablonów pakietów

Numery wersji i historia zmian

CONTRIBUTING.md

Plik historii

Śledzenie numeru wersji za pomocą bumpversion

Pliki Makefile i klasyfikatory

Klasyfikatory PyPI

Korzystanie z plików Makefile

Podsumowanie

Szybkie tworzenie pakietów

Czy zdarza ci się kopiować ten sam kod między plikami i marzyć o łatwiejszym sposobie na jego ponowne wykorzystanie? Opakowanie kodu w pakiety Pythona rozwiązuje ten problem! W tym kursie poznasz strukturę pakietów i dodatkowe pliki potrzebne do przekształcenia luźnego kodu w wygodne pakiety. Dowiesz się też, jak organizować importy, pisać dokumentację i dbać o styl kodu za pomocą flake8. Następnie przyśpieszysz tworzenie pakietów, korzystając z szablonów i narzędzia cookiecutter do generowania szkieletów pakietów. Na koniec nauczysz się używać setuptools i twine, aby budować pakiety i publikować je w PyPI — głównym repozytorium pakietów Pythona.

Introduction to Shell

Writing Functions in Python

Poznaj strukturę pakietu, import, dokumentację i styl kodu, a następnie twórz szablony i publikuj je.

Tworzenie pakietów w Pythonie

Twórz własne pakiety Python, by ułatwić używanie kodu i dzielenie się nim z innymi.

Odpowiednie filtrowanie stylu

Tworzenie pakietów w Pythonie

Interaktywne ćwiczenie praktyczne