Установка собственного пакета

Разработка пакетов на Python

James Fulton

Climate informatics researcher

Зачем устанавливать собственный пакет?

Внутри example_script.py

import mysklearn

Дерево каталогов пакета с подпакетами

home/
|-- mysklearn            <-- in same directory
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- in same directory

Зачем устанавливать собственный пакет?

Внутри example_script.py

import mysklearn

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

Дерево каталогов

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

setup.py

Используется для установки пакета
Содержит метаданные о пакете

Структура каталога пакета

Дерево каталогов пакета с подпакетами


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

Структура каталога пакета

Дерево каталогов пакета с подпакетами

mysklearn/      <-- outer directory
|-- mysklearn   <--- inner source code directory
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Структура каталога пакета

Дерево каталогов пакета с подпакетами

mysklearn/      <-- outer directory
|-- mysklearn   <--- inner source code directory
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- setup script in outer

Содержимое 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",

)

номер версии = (мажорный номер) . (минорный номер) . (номер патча)

Содержимое 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.*"]),

)

Редактируемая установка

pip install -e .

. = пакет в текущем каталоге
-e = редактируемый режим

Дерево каталогов пакета с подпакетами

mysklearn/  <-- navigate to here
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py

Давайте потренируемся!

Разработка пакетов на Python