Instalando seu próprio pacote

Desenvolvendo pacotes Python

James Fulton

Climate informatics researcher

Por que instalar seu próprio pacote?

Dentro de example_script.py

import mysklearn

Árvore de diretórios para pacote com subpacotes

home/
|-- mysklearn            <-- no mesmo diretório
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- no mesmo diretório

Por que instalar seu próprio pacote?

Dentro de example_script.py

import mysklearn

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

Árvore de diretórios

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

setup.py

É usado para instalar o pacote
Contém metadados do pacote

Estrutura de diretórios do pacote

Árvore de diretórios para pacote com subpacotes


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

Estrutura de diretórios do pacote

Árvore de diretórios para pacote com subpacotes

mysklearn/      <-- diretório externo
|-- mysklearn   <--- diretório interno do código-fonte
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Estrutura de diretórios do pacote

Árvore de diretórios para pacote com subpacotes

mysklearn/      <-- diretório externo
|-- mysklearn   <--- diretório interno do código-fonte
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- script de setup no externo

Dentro de 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",

)

número da versão = (major) . (minor) . (patch)

Dentro de 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.*"]),

)

Instalação editável

pip install -e .

. = pacote no diretório atual
-e = editável

Árvore de diretórios para pacote com subpacotes

mysklearn/  <-- navegue até aqui
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py

Vamos praticar!

Desenvolvendo pacotes Python