Je eigen package installeren

Python-pakketten ontwikkelen

James Fulton

Climate informatics researcher

Waarom je je eigen package moet installeren

In example_script.py

import mysklearn

Mapstructuur voor package met subpackages

home/
|-- mysklearn            <-- in dezelfde map
|  |-- __init__.py
|  |-- preprocessing
|  |   |-- __init__.py
|  |   |-- normalize.py
|  |   |-- standardize.py
|  |-- regression
|  |   |-- __init__.py
|  |   |-- regression.py
|  `-- utils.py
|-- example_script.py    <-- in dezelfde map
Python-pakketten ontwikkelen

Waarom je je eigen package moet installeren

In example_script.py

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

Mappenstructuur

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

setup.py

  • Wordt gebruikt om de package te installeren
  • Bevat metadata over de package
Python-pakketten ontwikkelen

Structuur van de package­map

Mapstructuur voor package met subpackages


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

Python-pakketten ontwikkelen

Structuur van de package­map

Mapstructuur voor package met subpackages

mysklearn/      <-- buitenste map
|-- mysklearn   <--- binnenste broncode­map
    |-- __init__.py
    |-- preprocessing
    |   |-- __init__.py
    |   |-- normalize.py
    |   |-- standardize.py
    |-- regression
    |   |-- __init__.py
    |   |-- regression.py
    |-- utils.py

Python-pakketten ontwikkelen

Structuur van de package­map

Mapstructuur voor package met subpackages

mysklearn/      <-- buitenste map
|-- mysklearn   <--- binnenste broncode­map
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py   <-- setup-script in buitenste map
Python-pakketten ontwikkelen

In 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",
)

versienummer = (major) . (minor) . (patch)

Python-pakketten ontwikkelen

In 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.*"]),
)
Python-pakketten ontwikkelen

Editable installatie

pip install -e .
  • . = package in huidige map
  • -e = editable (bewerkbaar)

Mapstructuur voor package met subpackages

mysklearn/  <-- navigeer hierheen
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- __init__.py
|   |   |-- normalize.py
|   |   |-- standardize.py
|   |-- regression
|   |   |-- __init__.py
|   |   |-- regression.py
|   |-- utils.py
|-- setup.py
Python-pakketten ontwikkelen

Laten we oefenen!

Python-pakketten ontwikkelen

Preparing Video For Download...