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

# Import required functions
____

# Call setup function
____(
    author="<your-name>",
    description="____",
    name="____",
    packages=____(____=____),
    version="____",
)


# Import required functions
from setuptools import setup, find_packages

# Call setup function
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",
)


Dodawanie skryptu setup

import impyrial

result = impyrial.length.convert_unit(10, 'in', 'yd')
print(result)


# Run this to install the package locally
pip install -e .


Lokalna instalacja pakietu

"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 160  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


import impyrial

result = impyrial.weight.convert_unit(2, 'lb', 'oz')
print(result)


"""Conversions between ounces and larger imperial weight units"""
OUNCES_PER_POUND = 16.0  # 16 ounces in a pound
OUNCES_PER_STONE = OUNCES_PER_POUND * 14.0  # 14 pounds in a stone

UNITS = ("oz", "lb", "st")


def ounces_to_pounds(x, reverse=False):
    """Convert weights between ounces and pounds.

    Parameters
    ----------
    x : array_like
        Weights in pounds.
    reverse : bool, optional
        If this is set to true this function converts from pounds to ounces
        instead of the default behaviour of ounces to pounds.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_POUND
    else:
        return x / OUNCES_PER_POUND


def ounces_to_stone(x, reverse=False):
    """Convert weights between ounces and stone.

    Parameters
    ----------
    x : array_like
        Weights in stone.
    reverse : bool, optional
        If this is set to true this function converts from stone to ounces
        instead of the default behaviour of ounces to stone.

    Returns
    -------
    ndarray
        An array of converted weights with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * OUNCES_PER_STONE
    else:
        return x / OUNCES_PER_STONE


Instalacja w trybie edytowalnym

Zarządzanie zależnościami

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",
    ____=____,
)


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'],
)


Zależności użytkownika

# Run this script to install the package locally
pip freeze > requirements.txt


Zależności deweloperskie

Dołączanie licencji i pisanie plików README

____

A package for converting between imperial unit lengths and weights.

This package was created for the ____DataCamp____ course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

____
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
____


# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course "Developing Python Packages".

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# Convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# Convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


Pisanie pliku README

# impyrial

A package for converting between imperial unit lengths and weights.

This package was created for the [DataCamp](https://www.datacamp.com) course Developing Python Packages.

### Features

- Convert lengths between miles, yards, feet and inches.
- Convert weights between hundredweight, stone, pounds and ounces.

### Usage

```
import impyrial

# convert 500 miles to feet
impyrial.length.convert_unit(500, from_unit='yd', to_unit='ft')  # returns 1500.0

# convert 100 ounces to pounds
impyrial.weight.convert_unit(100, from_unit='oz', to_unit='lb')  # returns 6.25
```


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

Publikowanie pakietu

# Run this code to complete the exercise
python3 setup.py sdist bdist_wheel


Tworzenie dystrybucji

# Run the following in the terminal:
# twine upload dist/*


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

Tworzenie katalogu testów

Pisanie podstawowych testów

Uruchamianie testów

Testowanie pakietu w różnych środowiskach

Konfiguracja tox

Uruchamianie tox

Dbaj o styl swojego pakietu

Odpowiednie filtrowanie stylu

Porządkowanie pliku za pomocą flake8

Ignorowanie wybranych błędów

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.

Dołączanie licencji i pisanie plików README

Create Your Free Account