Hướng dẫn create python package with all dependencies - tạo gói python với tất cả các phụ thuộc

Một dự án đơn giản

Hướng dẫn này sử dụng một dự án đơn giản có tên

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Tạo cấu trúc tệp sau đây cục bộ:

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Thư mục chứa các tệp Python phải khớp với tên dự án. Điều này đơn giản hóa cấu hình và rõ ràng hơn đối với người dùng cài đặt gói.

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

def add_one(number):
    return number + 1

Nếu bạn không quen thuộc với các mô -đun Python và các gói nhập, hãy dành vài phút để đọc tài liệu Python cho các gói và mô -đun.modules and import packages, take a few minutes to read over the Python documentation for packages and modules.

Khi bạn tạo cấu trúc này, bạn sẽ muốn chạy tất cả các lệnh trong hướng dẫn này trong thư mục

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Tạo các tệp gói

Bây giờ bạn sẽ thêm các tệp được sử dụng để chuẩn bị dự án để phân phối. Khi bạn hoàn thành, cấu trúc dự án sẽ trông như thế này:

packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── src/
│   └── example_package_YOUR_USERNAME_HERE/
│       ├── __init__.py
│       └── example.py
└── tests/

Tạo một thư mục kiểm tra

def add_one(number):
    return number + 1

Tạo pyproject.toml¶

def add_one(number):
    return number + 1

def add_one(number):
    return number + 1

def add_one(number):
    return number + 1

Ghi chú

Một số phụ trợ xây dựng là một phần của các công cụ lớn hơn cung cấp giao diện dòng lệnh với các tính năng bổ sung như khởi tạo dự án và quản lý phiên bản, cũng như xây dựng, tải lên và cài đặt các gói. Hướng dẫn này sử dụng các công cụ đơn mục đích hoạt động độc lập.

Mở

def add_one(number):
    return number + 1

def add_one(number):
    return number + 1

Truthling

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

setuptools

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

Flit

[build-system]
requires = ["flit_core>=3.2"]
build-backend = "flit_core.buildapi"

PDM

[build-system]
requires = ["pdm-pep517"]
build-backend = "pdm.pep517.api"

• def add_one(number):
      return number + 1
  

  5 là danh sách các gói cần thiết để xây dựng gói của bạn. Bạn không cần phải cài đặt chúng; Build Frontends như PIP sẽ tự động cài đặt chúng trong môi trường ảo tạm thời, bị cô lập để sử dụng trong quá trình xây dựng.pip will install them automatically in a temporary, isolated virtual environment for use during the build process.

• def add_one(number):
      return number + 1
  

  6 là tên của đối tượng Python mà Frontends sẽ sử dụng để thực hiện bản dựng.

def add_one(number):
    return number + 1

def add_one(number):
    return number + 1

[project]
name = "example_package_YOUR_USERNAME_HERE"
version = "0.0.1"
authors = [
  { name="Example Author", email="" },
]
description = "A small example package"
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
    "Programming Language :: Python :: 3",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
]

[project.urls]
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"

def add_one(number):
    return number + 1

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

def add_one(number):
    return number + 1

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

Tạo readme.md¶

Mở

packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── src/
│   └── example_package_YOUR_USERNAME_HERE/
│       ├── __init__.py
│       └── example.py
└── tests/

py -m pip install --upgrade pip

Tạo giấy phép lor

Nó rất quan trọng cho mỗi gói được tải lên chỉ mục gói Python để bao gồm giấy phép. Điều này cho người dùng cài đặt gói của bạn các điều khoản mà họ có thể sử dụng gói của bạn. Để được trợ giúp chọn giấy phép, hãy xem https://choosealicense.com/. Khi bạn đã chọn giấy phép, hãy mở

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

py -m pip install --upgrade pip

Hầu hết các phụ trợ xây dựng tự động bao gồm các tệp giấy phép trong các gói. Xem tài liệu phụ trợ của bạn để biết thêm chi tiết.

Bao gồm các tập tin khác

Các tệp được liệt kê ở trên sẽ được bao gồm tự động trong phân phối nguồn của bạn. Nếu bạn muốn bao gồm các tệp bổ sung, hãy xem tài liệu cho phụ trợ xây dựng của bạn.source distribution. If you want to include additional files, see the documentation for your build backend.

Tạo tài liệu lưu trữ phân phối

Bước tiếp theo là tạo các gói phân phối cho gói. Đây là những tài liệu lưu trữ được tải lên chỉ mục gói Python và có thể được cài đặt bởi PIP.distribution packages for the package. These are archives that are uploaded to the Python Package Index and can be installed by pip.

Đảm bảo bạn đã cài đặt phiên bản mới nhất của Pypa, bản dựng:build installed:

Unix/macOS

py -m pip install --upgrade pip

các cửa sổ

py -m pip install --upgrade pip

Bây giờ hãy chạy lệnh này từ cùng một thư mục nơi

def add_one(number):
    return number + 1

Lệnh này sẽ xuất ra rất nhiều văn bản và sau khi hoàn thành sẽ tạo hai tệp trong thư mục

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

py -m pip install --upgrade pip

Tệp

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

Tải lên Lưu trữ phân phối

Cuối cùng, đó là thời gian để tải gói của bạn lên chỉ mục gói Python!

Điều đầu tiên bạn cần làm là đăng ký một tài khoản trên TestPyPi, đây là một ví dụ riêng biệt của chỉ mục gói dự định để thử nghiệm và thử nghiệm. Nó rất tuyệt cho những thứ như hướng dẫn này, nơi chúng tôi không nhất thiết muốn tải lên chỉ mục thực. Để đăng ký một tài khoản, hãy truy cập https://test.pypi.org/account/register/ và hoàn thành các bước trên trang đó. Bạn cũng sẽ cần xác minh địa chỉ email của mình trước khi bạn có thể tải lên bất kỳ gói nào. Để biết thêm chi tiết, xem bằng cách sử dụng TestPypi.Using TestPyPI.

Để tải lên một cách an toàn dự án của bạn, bạn sẽ cần một mã thông báo API PYPI. Tạo một cái tại https://test.pypi.org/manage/account/#api-tokens, đặt phạm vi phạm vi trên toàn bộ tài khoản. Don Tiết đóng trang cho đến khi bạn đã sao chép và lưu mã thông báo - bạn đã giành được mã thông báo đó một lần nữa.Don’t close the page until you have copied and saved the token — you won’t see that token again.

Bây giờ bạn đã đăng ký, bạn có thể sử dụng Twine để tải lên các gói phân phối. Bạn cần phải cài đặt Twine:twine to upload the distribution packages. You’ll need to install Twine:

Unix/macOS

py -m pip install --upgrade pip

các cửa sổ

py -m pip install --upgrade pip

Bây giờ hãy chạy lệnh này từ cùng một thư mục nơi

def add_one(number):
    return number + 1

Unix/macOS

py -m pip install --upgrade pip

các cửa sổ

py -m pip install --upgrade pip

Bây giờ hãy chạy lệnh này từ cùng một thư mục nơi

def add_one(number):
    return number + 1

Lệnh này sẽ xuất ra rất nhiều văn bản và sau khi hoàn thành sẽ tạo hai tệp trong thư mục

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

py -m pip install --upgrade pip

Tệp

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

Tải lên Lưu trữ phân phối

Cuối cùng, đó là thời gian để tải gói của bạn lên chỉ mục gói Python!pip to install your package and verify that it works. Create a virtual environment and install your package from TestPyPI:

Unix/macOS

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

các cửa sổ

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Bây giờ hãy chạy lệnh này từ cùng một thư mục nơi

def add_one(number):
    return number + 1

Lệnh này sẽ xuất ra rất nhiều văn bản và sau khi hoàn thành sẽ tạo hai tệp trong thư mục

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Tệp

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

Tải lên Lưu trữ phân phối

Bạn có thể kiểm tra rằng nó đã được cài đặt chính xác bằng cách nhập gói. Hãy chắc chắn rằng bạn vẫn còn trong môi trường ảo của mình, sau đó chạy Python:

và nhập gói:

packaging_tutorial/
└── src/
    └── example_package_YOUR_USERNAME_HERE/
        ├── __init__.py
        └── example.py

Bước tiếp theo¶

Xin chúc mừng, bạn đã đóng gói và phân phối một dự án Python! ✨ 🍰 ✨ 🍰 ✨

Hãy nhớ rằng hướng dẫn này đã chỉ cho bạn cách tải lên gói của bạn để kiểm tra PYPI, đây là một bộ lưu trữ vĩnh viễn. Hệ thống thử nghiệm thỉnh thoảng xóa các gói và tài khoản. Tốt nhất là sử dụng TestPypi để thử nghiệm và thử nghiệm như hướng dẫn này.

Khi bạn đã sẵn sàng để tải lên một gói thực sự lên chỉ mục gói Python, bạn có thể làm nhiều như bạn đã làm trong hướng dẫn này, nhưng với những khác biệt quan trọng này:

• Chọn một tên đáng nhớ và độc đáo cho gói của bạn. Bạn không cần phải nối lại tên người dùng của mình như bạn đã làm trong hướng dẫn, nhưng bạn có thể sử dụng một tên hiện có.

• Đăng ký một tài khoản trên https://pypi.org - Lưu ý rằng đây là hai máy chủ riêng biệt và chi tiết đăng nhập từ máy chủ thử nghiệm không được chia sẻ với máy chủ chính.

• Sử dụng

  [build-system]
  requires = ["setuptools>=61.0"]
  build-backend = "setuptools.build_meta"
  

  7 để tải lên gói hàng của bạn và nhập thông tin đăng nhập của bạn cho tài khoản bạn đã đăng ký trên PYPI thực. Bây giờ bạn đã tải lên gói trong sản xuất, bạn không cần phải chỉ định

  [build-system]
  requires = ["setuptools>=61.0"]
  build-backend = "setuptools.build_meta"
  

  8; Gói sẽ tải lên https://pypi.org/ theo mặc định.

• Cài đặt gói của bạn từ PYPI thực sự bằng

  [build-system]
  requires = ["setuptools>=61.0"]
  build-backend = "setuptools.build_meta"
  

  9.

Tại thời điểm này nếu bạn muốn đọc thêm về các thư viện Python đóng gói thì đây là một số điều bạn có thể làm:

• Xem xét các công cụ đóng gói cung cấp một giao diện dòng lệnh duy nhất để quản lý và đóng gói dự án, chẳng hạn như hatch, flit, pdm và thơ.hatch, flit, pdm, and poetry.

• Đọc PEP 517 và PEP 518 để biết nền và chi tiết về cấu hình công cụ xây dựng.PEP 517 and PEP 518 for background and details on build tool configuration.

• Đọc về bao bì mở rộng nhị phân.Packaging binary extensions.