Gói GitHub Python

Đây là bản demo đầu cuối nhằm tạo thuận lợi cho quá trình chia sẻ phần mềm nguồn mở hoặc công việc nội bộ

Ảnh của Sigmund trên Bapt

Đây là bản demo đầu cuối chia sẻ mã của bạn. Dự án nhằm mục đích giúp bạn hiểu cách xuất bản chính xác các mô-đun/gói python của bạn trên PyPI ra bên ngoài và chia sẻ công việc của bạn với đồng nghiệp trong nội bộ. Tôi cũng đã chuẩn bị một Repo GitHub cho bạn để giúp cuộc sống của bạn dễ dàng hơn

Bạn có thể truy cập trực tiếp vào repo này để biết thêm chi tiết. Kho lưu trữ GitHub

Bước 1

Lần lượt vào 2 trang web sau để đăng ký tài khoản riêng

• thử nghiệm PyPI. https. //kiểm tra. pypi. tổ chức/
• PyPI. https. //pypi. tổ chức/

Ghi chú. Bạn có thể bỏ qua phần này nếu bạn không muốn xuất bản công khai gói của mình. Ngoài ra, tôi thực sự khuyên bạn nên thử gói của mình trên trang web kiểm tra trước để tránh nhầm lẫn trong quá trình tải lên. Vì bất kỳ thay đổi nào bạn thực hiện đối với gói của mình trên PyPI đều không thể hoàn nguyên, lỗi tải lên có thể dẫn đến một bản vá lỗi cho gói của bạn. Bạn muốn tránh điều đó

Bước 2

lựa chọn 1. Chuyển đổi kho lưu trữ này sang tài khoản GitHub của riêng bạn và cung cấp nó ở địa phương của bạn. Bạn có thể thực hiện hầu hết các thay đổi trên GitHub, nhưng bạn sẽ cần xuất bản gói của mình qua cmd với các tệp đó có sẵn trong cục bộ

Lựa chọn 2. Tạo các tệp cần thiết theo cách thủ công. Và đây là danh sách các tập tin cốt lõi bạn sẽ cần

Hình ảnh của tác giả

tôi biết đó là rất nhiều. Nhưng chịu đựng với tôi. Bạn chỉ cần thực hiện các thay đổi cần thiết đối với một số trong số chúng và phần còn lại sẽ giữ nguyên như mặc định

TÙY CHỌN — Nhiều mô-đun

Giả sử bạn có nhiều lớp với các hàm được tạo trong các tệp riêng biệt. Bạn muốn tạo các thư mục [hoặc thư mục con] theo quy ước này

Hình ảnh của tác giả

Bên trong mỗi thư mục, hãy cập nhật “__init__. py” bằng cách làm điều này

Trong thư mục chính, cập nhật “__init__. py” bằng cách làm điều này

Sau đó, người dùng sẽ có thể nhập thư viện của bạn đúng cách như thế này

Nếu bạn muốn nhập thứ gì đó từ thư mục chính [trước đó], đây là những gì bạn nên làm

Cân nhắc thêm danh sách vào “__init__” của bạn. py” cho mỗi thư viện con, để người dùng có thể kiểm tra chức năng nào khả dụng

Bước 3

Cài đặt gói python sau trong cmd của bạn

Bước 4

Thực hiện các thay đổi sau theo bất kỳ thứ tự nào bạn muốn

1. Thay thế your_main_code. py trong thư mục src với gói python của riêng bạn và để lại “__init__. py” giống như nếu bạn chỉ xuất bản một mô-đun
2. Thực hiện các thay đổi đối với thiết lập. py và hướng dẫn được bao gồm trong tệp đó
3. Chọn giấy phép của riêng bạn. Mở tệp GIẤY PHÉP, nhấp vào Chỉnh sửa, nhấp vào “Chọn mẫu giấy phép” và chọn giấy phép đáp ứng nhu cầu của bạn. Nếu bạn không biết giấy phép nào phù hợp với mình, bạn có thể sử dụng giấy phép MIT, đây là một trong những lựa chọn phổ biến nhất. Hoặc, bạn có thể sử dụng liên kết này để chọn một. https. //chọn giấy phép. com/
4. Cập nhật CHANGELOG. md để phản ánh thông tin phiên bản
5. Không bắt buộc. tạo một “bài kiểm tra. py” và đặt tệp vào thư mục kiểm tra. Hoặc bạn có thể xóa toàn bộ thư mục nếu bạn tự tin rằng mọi thứ hoạt động tốt trong mô-đun của mình
6. Xóa mọi thứ trong “README” này. md” và cập nhật tệp với mô tả dài về gói của bạn

Bước 5

Bạn có nhiều lựa chọn cho bước 5 để thực hiện các bước còn lại. Đây là hai ví dụ

1. Làm điều đó trong cmd - Command Prompt

• Tại địa phương của bạn, hãy mở cmd, điều hướng đến thư mục chứa gói của bạn và nhập nội dung sau

2. Làm điều đó trong thiết bị đầu cuối Jupyter Notebook

Bước 6

Trong bước này, chúng tôi sẽ sử dụng đoạn mã sau trong cmd/terminal để xây dựng gói của bạn

Khi bạn chạy mã, bạn sẽ thấy hai thư mục sau trong thư mục hiện tại

• xây dựng
• quận

Trong thư mục dist, bạn sẽ thấy tệp 'tar' có tên là “TheNameofYourPackage-TheVersionofYourPackage. hắc ín. gz”. Cho đến thời điểm này, nếu bạn không cần xuất bản mã của mình ra công chúng; . Tất cả những gì họ cần làm là thực hiện “cài đặt pip” để sử dụng mã của bạn

TÙY CHỌN — Kiểm tra gói của bạn trên PyPI

Bây giờ, bạn sắp xuất bản gói của mình lên PyPI. Trước khi bạn công khai, một điều nữa bạn có thể muốn làm là kiểm tra xem gói của bạn có hoạt động như mong đợi không khi mọi người tải xuống. Những gì bạn có thể làm là tạo một thư mục có tên là “test”, và tạo một bài kiểm tra. py, bao gồm một số triển khai mẫu của gói của bạn. Sau đó, gõ “pytest” trong cmd/terminal của bạn. Nếu mọi thứ hoạt động tốt, nó sẽ chạy thử nghiệm của bạn. py tự động và vượt qua. Nếu không, nó sẽ phát sinh lỗi và bạn nên sửa các lỗi tương ứng trước khi chuyển sang bước tiếp theo

Và đây là một điều nữa mà bạn có thể muốn thử kiểm tra xem kiến ​​trúc gói của bạn có hoạt động tốt không. Trong cmd/terminal, gõ đoạn mã sau

Bạn sẽ thấy một cái gì đó như thế này

Checking distribution dist/TheNameofYourPackage-TheVersionofYourPackage-1.0.0-py3-none-any.whl: PassedChecking distribution dist/TheNameofYourPackage-TheVersionofYourPackage.tar.gz: Passed

Bước 7

Tải gói của bạn lên TestPyPI

Sau đó, bạn sẽ thấy một liên kết dẫn đến phiên bản thử nghiệm gói của bạn trên TestPyPI. Kiểm tra nó ra. Nếu có bất kỳ lỗi đánh máy hoặc lỗi không tương thích nào, hãy sửa chúng trước khi tải gói của bạn lên PyPI thực

Và, bây giờ, đó là thời điểm thú vị nhất, hãy tải gói của bạn lên PyPI để giúp đỡ hàng trăm nghìn người trong cộng đồng của chúng tôi

Đến thời điểm này, gói của bạn phải chính thức trực tuyến và có thể được “cài đặt pip” bởi bất kỳ ai vào bất kỳ lúc nào từ bất kỳ đâu. khoảnh khắc trọng đại. Tôi vẫn nhớ cảm giác của mình lúc nhìn thấy gói hàng đầu tiên của mình ở ngoài kia. Tôi tự nhủ, đó là lý do tại sao tôi viết mã

Bạn có thể đặt Python trên GitHub không?

Gói GitHub là gì?

Gói Python nào là tốt nhất?

GitHub trong Python là gì?