การติดตั้งแพ็กเกจของตัวเอง

การพัฒนา Python Packages

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

ใช้สำหรับติดตั้งแพ็กเกจ
บรรจุข้อมูล metadata ของแพ็กเกจ

โครงสร้างไดเรกทอรีของแพ็กเกจ

โครงสร้างไดเรกทอรีของแพ็กเกจที่มีแพ็กเกจย่อย


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

)

version number = (major number) . (minor number) . (patch number)

ภายใน 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.*"]),

)

การติดตั้งแบบ Editable

pip install -e .

. = แพ็กเกจในไดเรกทอรีปัจจุบัน
-e = editable

โครงสร้างไดเรกทอรีของแพ็กเกจที่มีแพ็กเกจย่อย

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

มาฝึกกันเถอะ!

การพัฒนา Python Packages