Instalowanie własnego pakietu

Tworzenie pakietów w Pythonie

James Fulton

Climate informatics researcher

Dlaczego warto instalować własny pakiet?

Zawartość pliku example_script.py

import mysklearn

Drzewo katalogów dla pakietu z podpakietami

home/
|-- mysklearn            <-- w tym samym katalogu
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- w tym samym katalogu

Dlaczego warto instalować własny pakiet?

Zawartość pliku example_script.py

import mysklearn

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'mysklearn'

Drzewo katalogów

home/
|-- mypackages
|   |-- mysklearn     <---
|       |-- __init__.py
|       |-- preprocessing
|       |   |-- __init__.py
|       |   |-- normalize.py
|       |   |-- standardize.py
|       |-- regression
|           |-- __init__.py
|           |-- regression.py
`-- myscripts
    `-- example_script.py     <---

setup.py

Służy do instalacji pakietu
Zawiera metadane pakietu

Struktura katalogów pakietu

Drzewo katalogów dla pakietu z podpakietami


    mysklearn/
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Struktura katalogów pakietu

Drzewo katalogów dla pakietu z podpakietami

mysklearn/      <-- katalog zewnętrzny
|-- mysklearn   <--- katalog kodu źródłowego
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Struktura katalogów pakietu

Drzewo katalogów dla pakietu z podpakietami

mysklearn/      <-- katalog zewnętrzny
|-- mysklearn   <--- katalog kodu źródłowego
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- skrypt instalacyjny

Zawartość pliku setup.py

# Import required functions
from setuptools import setup


# Call setup function
setup(

    author="James Fulton",

    description="A complete package for linear regression.",

    name="mysklearn",

    version="0.1.0",

)

numer wersji = (numer główny) . (numer poboczny) . (numer poprawki)

Zawartość pliku setup.py

# Import required functions
from setuptools import setup, find_packages

# Call setup function
setup(
    author="James Fulton",
    description="A complete package for linear regression.",
    name="mysklearn",
    version="0.1.0",

    packages=find_packages(include=["mysklearn", "mysklearn.*"]),

)

Instalacja w trybie edytowalnym

pip install -e .

. = pakiet w bieżącym katalogu
-e = tryb edytowalny

Drzewo katalogów dla pakietu z podpakietami

mysklearn/  <-- przejdź tutaj
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py

Czas na ćwiczenia!

Tworzenie pakietów w Pythonie