Mẫu đăng ký bình python

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

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

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

Tạo cấu trúc tệp sau tại địa phương

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 giúp đơ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

Cần có

def add_one[number]:
    return number + 1

def add_one[number]:
    return number + 1

def add_one[number]:
    return number + 1

Nếu bạn chưa quen với mô-đun và các gói nhập, 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

def add_one[number]:
    return number + 1

Tạo các tập tin gói¶

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

python3 -m pip install --upgrade pip

Tạo một thư mục thử nghiệm¶

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

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

nở

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

py -m pip install --upgrade pip

• def add_one[number]:
      return number + 1
  

  9 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 cài đặt chúng; . pip will install them automatically in a temporary, isolated virtual environment for use during the build process.

• python3 -m pip install --upgrade pip
  

  10 là tên của đối tượng Python mà giao diện người dùng sẽ sử dụng để thực hiện quá trình xây dựng

def add_one[number]:
    return number + 1

python3 -m pip install --upgrade pip

py -m pip install --upgrade pip

def add_one[number]:
    return number + 1

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

Tạo README. md¶

Mở

python3 -m pip install --upgrade pip

py -m pip install --upgrade pip

Tạo GIẤY PHÉP¶

Điều quan trọng đối với mọi gói được tải lên Chỉ mục gói Python phải 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 biết các điều khoản mà theo đó 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. //chọn giấy phép. com/. Khi bạn đã chọn một giấy phép, hãy mở

python3 -m pip install --upgrade pip

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 khác¶

Các tệp được liệt kê ở trên sẽ tự động được bao gồm trong bản 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 dành cho chương trình phụ trợ xây dựng của bạn.

Tạo kho lưu trữ phân phối¶

Bước tiếp theo là tạo gói phân phối cho gói. Đây là những kho lưu trữ được tải lên Chỉ mục gói Python và có thể được cài đặt bởi pip .

Đảm bảo bạn đã cài đặt phiên bản mới nhất của bản dựng của PyPA.

Unix/macOS

py -m pip install --upgrade pip

py -m pip install --upgrade pip

Mẹo

Nếu bạn gặp sự cố khi cài đặt các gói này, hãy xem hướng dẫn Cài đặt gói .

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

def add_one[number]:
    return number + 1

Unix/macOS

py -m pip install --upgrade pip

py -m pip install --upgrade pip

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

python3 -m pip install --upgrade pip

py -m pip install --upgrade pip

Tệp

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

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

Cuối cùng, đã đến lúc 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 phiên bản riêng biệt của chỉ mục gói dành cho kiểm tra và thử nghiệm. Thật tuyệt vời cho những thứ như hướng dẫn này mà chúng tôi không nhất thiết muốn tải lên chỉ mục thực. Để đăng ký tài khoản, hãy truy cập https. //kiểm tra. 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 có thể tải lên bất kỳ gói nào. Để biết thêm chi tiết, hãy xem Sử dụng TestPyPI .

Để tải lên dự án của bạn một cách an toàn, bạn sẽ cần mã thông báo API PyPI. Tạo một cái tại https. //kiểm tra. pypi. org/manage/account/#api-tokens, đặt “Phạm vi” thành “Toàn bộ tài khoản”. Không đóng trang cho đến khi bạn đã sao chép và lưu mã thông báo — bạn sẽ không thấy mã thông báo đó nữa

Bây giờ bạn đã đăng ký, bạn có thể sử dụng twine để tải các gói phân phối lên. Bạn sẽ cần cài đặt Twine.

Unix/macOS

py -m pip install --upgrade pip

py -m pip install --upgrade pip

Sau khi cài đặt, hãy chạy Twine để tải lên tất cả các tệp lưu trữ trong

python3 -m pip install --upgrade pip

Unix/macOS

py -m pip install --upgrade pip

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

Bạn sẽ được nhắc nhập tên người dùng và mật khẩu. Đối với tên người dùng, hãy sử dụng

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

Sau khi lệnh hoàn thành, bạn sẽ thấy đầu ra tương tự như thế này

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

Sau khi tải lên, gói của bạn sẽ có thể xem được trên TestPyPI; .

python3 -m pip install --upgrade pip

Cài đặt gói mới tải lên của bạn¶

Bạn có thể sử dụng pip để cài đặt gói của mình và xác minh rằng gói đó hoạt động. Tạo môi trường ảo và cài đặt gói của bạn từ TestPyPI.

Unix/macOS

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

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

Đảm bảo chỉ định tên người dùng của bạn trong tên gói

pip nên cài đặt gói từ TestPyPI và đầu ra sẽ trông giống như thế này

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

Ghi chú

Ví dụ này sử dụng cờ

python3 -m pip install --upgrade pip

python3 -m pip install --upgrade pip

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

Unix/macOS

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

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

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 gói của bạn lên Test PyPI, đây không phải là bộ lưu trữ vĩnh viễn. Hệ thống Kiểm tra thỉnh thoảng xóa các gói và tài khoản. Tốt nhất là sử dụng TestPyPI để kiểm tra và thử nghiệm như hướng dẫn này

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

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

• Đăng ký tài khoản trên https. //pypi. org - lưu ý rằng đây là hai máy chủ riêng biệt và thông tin đă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

  python3 -m pip install --upgrade pip
  

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

  python3 -m pip install --upgrade pip
  

  92; . //pypi. org/ theo mặc định

• Cài đặt gói của bạn từ PyPI thực bằng cách sử dụng

  python3 -m pip install --upgrade pip
  

  93

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