Làm cách nào để thiết lập dự án python?

Bước 1] Mở Trình chỉnh sửa PyCharm. Bạn có thể xem màn hình giới thiệu về PyCharm. Để tạo một dự án mới, nhấp vào “Tạo dự án mới”

Bước 2] Bạn sẽ cần chọn một vị trí

1. Bạn có thể chọn vị trí mà bạn muốn tạo dự án. Nếu bạn không muốn thay đổi vị trí thì hãy giữ nguyên vị trí đó nhưng ít nhất hãy đổi tên từ “untitled” thành một cái gì đó có ý nghĩa hơn, chẳng hạn như “FirstProject”
2. PyCharm lẽ ra đã tìm thấy trình thông dịch Python mà bạn đã cài đặt trước đó
3. Tiếp theo Nhấp vào nút “Tạo”

Bước 3] Bây giờ, hãy chuyển đến menu “Tệp” và chọn “Mới”. Tiếp theo, chọn “Tệp Python”

Bước 4] Một cửa sổ bật lên mới sẽ xuất hiện. Bây giờ hãy nhập tên của tệp bạn muốn [Ở đây chúng tôi cung cấp cho Hello HelloWorld] và nhấn vào OK OK

Bước 5] Bây giờ gõ một chương trình đơn giản – in [‘Xin chào thế giới. ’]

Bước 6] Bây giờ, hãy vào menu “Run” và chọn “Run” để chạy chương trình của bạn

Bước 7] Bạn có thể thấy đầu ra của chương trình ở cuối màn hình

Bước 8] Đừng lo lắng nếu bạn chưa cài đặt Pycharm Editor, bạn vẫn có thể chạy mã từ dấu nhắc lệnh. Nhập đúng đường dẫn của tệp trong dấu nhắc lệnh để chạy chương trình

Mọi nhà phát triển phần mềm và nhà khoa học dữ liệu đều phải trải qua quá trình tạo gói. Bạn sẽ học được rất nhiều trên đường đi. Chỉ cần chắc chắn rằng bạn có thời gian. 🕰

Tạo một gói mã nguồn mở Python nghe có vẻ khó khăn, nhưng bạn không cần phải là một cựu chiến binh hoa râm. Bạn cũng không cần một ý tưởng sản phẩm phức tạp. Bạn cần sự kiên trì và thời gian. Hy vọng rằng hướng dẫn này sẽ giúp bạn cần ít hơn cả hai. 😃

Xây dựng một cái gì đó đẹp 😃

Trong bài viết này, chúng ta sẽ thực hiện từng bước để tạo một gói Python cơ bản. Trong các bài viết trong tương lai, chúng tôi sẽ thiết lập kiểm tra tự động và xây dựng tài liệu. Chúng tôi cũng sẽ tích hợp các ứng dụng hữu ích khác để cải thiện quá trình phát triển gói của bạn. Sau đó, bạn có thể mở rộng những gì bạn đã xây dựng để phù hợp với nhu cầu của mình

Nếu bạn đang muốn học Python, hãy xem cuốn sách Memorable Python của tôi

Hướng dẫn này dành cho macOS với Python 3. 7. Mọi thứ hiện đang hoạt động, nhưng mọi thứ thay đổi nhanh chóng, vì vậy không có gì đảm bảo nếu bạn đang đọc nó vào năm 2030. Trong mã bên dưới thay thế my_package, my_file, v.v. với tên riêng của bạn

Chúng ta hãy đi đến đó. 🚀

Bước 1. Lên kế hoạch

Cuối cùng, chúng tôi đang lên kế hoạch tạo một thư viện rất đơn giản để sử dụng trong chương trình Python. Gói này sẽ cho phép người dùng dễ dàng chuyển đổi sổ ghi chép Jupyter thành tệp HTML hoặc tập lệnh Python

Lần lặp lại đầu tiên của gói của chúng tôi sẽ cho phép người dùng gọi một chức năng sẽ in một câu lệnh

Bây giờ chúng tôi biết những gì chúng tôi muốn làm, chúng tôi cần quyết định gọi gói là gì

Bước 2. Gọi tên nó

Đặt tên cho mọi thứ là khó khăn. Tên nên độc đáo, ngắn gọn và dễ nhớ. Chúng cũng phải là chữ thường và chắc chắn không có bất kỳ dấu gạch ngang hoặc dấu chấm câu nào khác trong đó. Dấu gạch dưới không được khuyến khích. Khi bạn đang xây dựng gói của mình, hãy kiểm tra xem tên đó có sẵn trên GitHub, Google và PyPI không

Nếu bạn có nhiều hy vọng rằng một ngày nào đó gói của bạn sẽ có 10.000 sao GitHub, thì bạn có thể muốn kiểm tra xem tên đó có tồn tại trên mạng xã hội không. Trong ví dụ này, tôi sẽ đặt tên cho gói của mình là notebookc vì nó có sẵn, ngắn gọn và bán mô tả. 😄

Bước 3. Cấu hình môi trường

Đảm bảo bạn có Python 3. 7, GitHub và Homebrew đã được cài đặt và định cấu hình. Nếu bạn cần bất kỳ thứ gì ở đây là chi tiết

con trăn

Tải xuống Python 3. 7 tại đây và cài đặt nó

GitHub

Nếu bạn chưa có tài khoản GitHub, hãy truy cập vào đây và đăng ký một tài khoản miễn phí. Xem cách cài đặt và cấu hình Git tại đây. Bạn muốn công cụ dòng lệnh. Theo các liên kết để tải xuống, cài đặt, đặt tên người dùng và đặt địa chỉ email cam kết của bạn

pha chế tại nhà

Homebrew là trình quản lý gói dành riêng cho Mac. Hướng dẫn cài đặt ở đây

Venv

Kể từ Python 3. 6, bạn nên sử dụng venv để tạo môi trường ảo để phát triển gói. Có nhiều cách để quản lý môi trường ảo bằng Python và các đề xuất đã phát triển. Xem thảo luận tại đây, nhưng hãy cẩn thận khi đi xuống hố thỏ này. 🕳

venv được cài đặt với Python kể từ Python 3. 3. Lưu ý rằng venv cài đặt pip và setuptools vào môi trường ảo kể từ Python 3. 4

Tạo Python 3. 7 môi trường ảo bằng lệnh sau

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

2

Thay thế my_env bằng bất kỳ tên nào bạn thích. Kích hoạt môi trường ảo của bạn như thế này

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

3

Bây giờ bạn sẽ thấy

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

4— hoặc bất cứ thứ gì bạn đặt tên cho môi trường ảo của mình— ở ngoài cùng bên trái trong dấu nhắc thiết bị đầu cuối của bạn

Khi bạn hoàn thành quá trình phát triển của mình, hãy hủy kích hoạt môi trường ảo của bạn bằng

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

5

Bây giờ, hãy quan tâm đến việc thiết lập mọi thứ trên GitHub

Bước 4. Tạo tổ chức trên GitHub

GitHub dẫn đầu thị trường về đăng ký kiểm soát phiên bản. GitLab và Bitbucket là các tùy chọn phổ biến khác. Chúng tôi sẽ sử dụng GitHub trong hướng dẫn này

• Bạn sẽ sử dụng nhiều Git và GitHub, vì vậy nếu bạn chưa quen, hãy xem bài viết của tôi tại đây
• Tạo một tổ chức mới trên Github. Làm theo lời nhắc. Tôi đặt tên cho tổ chức của mình là notebooktoall. Bạn có thể tạo repo bằng tài khoản cá nhân của riêng mình, nhưng một phần của mục tiêu là tìm hiểu cách thiết lập dự án nguồn mở cho cộng đồng lớn hơn

Bước 5. Thiết lập Kho lưu trữ GitHub

Tạo một kho lưu trữ mới. Tôi đặt tên cho sổ ghi chép repo của mình

thêm một. gitignore từ danh sách thả xuống. Chọn Python cho kho lưu trữ của bạn. Nội dung của bạn. tệp gitignore sẽ khớp với các thư mục và loại tệp để loại trừ khỏi repo Git của bạn. Bạn có thể thay đổi của bạn. gitignore sau để loại trừ các tệp nhạy cảm hoặc không cần thiết khác

Tôi khuyên bạn nên chọn một giấy phép từ danh sách thả xuống Thêm giấy phép. Giấy phép xác định những gì người dùng nội dung kho lưu trữ của bạn có thể làm. Một số giấy phép dễ dãi hơn những giấy phép khác. Luật bản quyền mặc định được áp dụng nếu không có giấy phép nào được chọn. Tìm hiểu thêm về giấy phép tại đây

Đối với dự án này, tôi đã chọn Giấy phép Công cộng GNU v3. 0 vì nó phổ biến, hợp pháp và “đảm bảo cho người dùng cuối quyền tự do chạy, nghiên cứu, chia sẻ và sửa đổi phần mềm” — nguồn

Bước 6. Sao chép và thêm thư mục

Chọn nơi bạn muốn sao chép cục bộ repo của mình và chạy phần sau

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

6

Thay thế tổ chức của bạn và repo

Di chuyển vào thư mục dự án của bạn với GUI trên máy tính để bàn hoặc trình chỉnh sửa mã. Hoặc sử dụng dòng lệnh với

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

7 và sau đó xem các tệp của bạn với

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

0. Các thư mục và tệp ban đầu của bạn sẽ trông như thế này

.git
.gitignore 
LICENSE
README.rst

Tạo một thư mục con cho các tệp dự án chính của bạn. Tôi đề nghị bạn đặt tên cho thư mục con chính này cùng tên với gói của bạn. Đảm bảo rằng tên không có bất kỳ khoảng trắng nào trong đó. 🙂

Tạo một tệp có tên __init__. py trong thư mục con chính của bạn. Tệp này sẽ vẫn trống cho đến bây giờ. Tệp này là cần thiết để nhập các tệp trong thư mục này

Tạo một tệp khác có cùng tên với thư mục con chính của bạn với. py nối vào nó. Tập tin của tôi được đặt tên notebookc. py. Bạn có thể đặt tên cho tệp Python này bất cứ điều gì bạn thích. Người dùng gói của bạn sẽ tham khảo tên của tệp này khi nhập mô-đun của bạn

Nội dung thư mục notebookc của tôi bây giờ trông như thế này

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

Bước 7. Tạo và cài đặt tests_dev. txt

Ở cấp cao nhất của thư mục dự án của bạn, hãy tạo một tests_dev. tập tin txt. Thường thì tệp này được đặt tên là yêu cầu. txt. Gọi nó là tests_dev. txt nhấn mạnh rằng các gói này chỉ được cài đặt bởi các nhà phát triển dự án

Trong yêu cầu_dev. txt, chỉ định rằng pip và bánh xe sẽ được cài đặt

pip==19.0.3
wheel==0.33.1

Lưu ý rằng chúng tôi chỉ định các phiên bản chính xác của các gói này với dấu bằng kép và dấu chính đầy đủ. diễn viên phụ. số phiên bản vi mô. Nếu bạn đang đọc phần này trong tương lai, bạn sẽ muốn sử dụng các phiên bản cập nhật. Kiểm tra https. //pypi. org/ để xem các phiên bản gói cập nhật

Ghim các phiên bản gói của bạn trong tests_dev. txt

Cộng tác viên phân nhánh repo dự án và cài đặt tests_dev được ghim. txt với pip sẽ có các phiên bản gói giống như bạn đã làm. Bạn biết họ sẽ làm việc cho họ. Ngoài ra, Read The Docs sẽ sử dụng tệp này để cài đặt các gói khi nó xây dựng tài liệu của bạn

Trong môi trường ảo được kích hoạt của bạn, hãy cài đặt các gói trong tests_dev. txt bằng lệnh sau

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

1

Bạn sẽ muốn cập nhật các gói này khi các phiên bản mới hơn được phát hành. Hiện tại, bạn có thể cài đặt bất kỳ phiên bản nào mới nhất bằng cách tìm kiếm PyPI

Chúng tôi sẽ cài đặt một công cụ để trợ giúp quá trình này trong một bài viết trong tương lai. Theo dõi tôi để đảm bảo bạn không bỏ lỡ

Bước 8. Mã và cam kết

Hãy tạo một chức năng cơ bản cho mục đích trình diễn. Bạn có thể tạo chức năng tuyệt vời của riêng mình sau. 👍

Nhập nội dung sau vào tệp chính của bạn [đối với tôi đó là notebookc/notebookc/notebookc. py]

Đó là chức năng của chúng tôi trong tất cả vinh quang của nó. 😃

Các chuỗi tài liệu bắt đầu và kết thúc bằng ba dấu ngoặc kép liên tiếp. Chúng sẽ được sử dụng trong bài viết sau để tự động tạo tài liệu

Hãy cam kết thay đổi của chúng tôi. Xem bài viết này nếu bạn muốn xem lại quy trình công việc Git

Bước 9. Tạo thiết lập. py

thiết lập. tệp py là tập lệnh xây dựng cho gói của bạn. Chức năng thiết lập từ Setuptools sẽ xây dựng gói của bạn để tải lên PyPI. Setuptools bao gồm thông tin về gói của bạn, số phiên bản của bạn và những gói nào khác được yêu cầu cho người dùng

Đây là thiết lập ví dụ của tôi. tập tin py

Lưu ý rằng long_description được đặt thành nội dung của README của bạn. tập tin md

Danh sách yêu cầu được chỉ định trong setuptools. cài đặt. install_requires bao gồm tất cả các gói phụ thuộc cần thiết để gói của bạn hoạt động

Không giống như danh sách các gói cần thiết để phát triển trong tests_dev. txt, danh sách các gói này phải dễ dãi nhất có thể. Đọc thêm về lý do tại sao ở đây

Giới hạn danh sách các gói install_requires này ở mức chỉ những gì cần thiết — bạn không muốn khiến người dùng cài đặt các gói không cần thiết. Lưu ý rằng bạn chỉ cần liệt kê các gói không phải là một phần của thư viện chuẩn Python. Người dùng của bạn sẽ cài đặt Python nếu họ sẽ sử dụng gói của bạn. 😄

Gói của chúng tôi không yêu cầu bất kỳ phụ thuộc bên ngoài nào, vì vậy bạn có thể loại trừ bốn gói được liệt kê trong ví dụ trên

Một cộng tác viên rẽ nhánh repo dự án và cài đặt các gói được ghim bằng pip sẽ có các phiên bản gói giống như bạn đã sử dụng. Điều này có nghĩa là mọi thứ nên hoạt động. 🤞

Thay đổi thông tin setuptools khác để phù hợp với thông tin gói của bạn. Có nhiều đối số và phân loại từ khóa tùy chọn khác - xem danh sách tại đây. Hướng dẫn chi tiết hơn để thiết lập. py có thể được tìm thấy ở đây và ở đây

Cam kết mã của bạn với repo Git cục bộ của bạn. Hãy sẵn sàng để xây dựng một gói

Bước 10. Xây dựng phiên bản đầu tiên

Twine là tập hợp các tiện ích để xuất bản an toàn các gói Python trên PyPI. Thêm gói Twine vào dòng trống tiếp theo của tests_dev. txt như vậy

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

2

Sau đó cài đặt Twine vào môi trường ảo của bạn bằng cách cài đặt lại tests_dev của bạn. gói txt

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

1

Sau đó chạy lệnh sau để tạo tệp gói của bạn

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

4

Nên tạo nhiều thư mục ẩn. dist, build và — trong trường hợp của tôi — notebookc. trứng-thông tin. Hãy xem các tệp trong thư mục dist. Các. tệp whl là tệp bánh xe - bản phân phối được xây dựng. Các. hắc ín. tệp gz là kho lưu trữ nguồn

Bánh xe

Trên máy của người dùng, pip sẽ cài đặt các gói dưới dạng bánh xe bất cứ khi nào có thể. Bánh xe lắp đặt nhanh hơn. Khi pip không thể cài đặt bánh xe, nó sẽ quay trở lại kho lưu trữ nguồn

Hãy sẵn sàng để tải lên kho lưu trữ nguồn và bánh xe của chúng tôi

Bước 11. Tạo tài khoản TestPyPI

PyPI là viết tắt của Chỉ mục gói Python. Đó là trình quản lý gói Python chính thức. pip lấy các thư viện từ PyPI khi chúng chưa được cài đặt cục bộ

PyPI

TestPyPI là phiên bản thử nghiệm hoạt động của PyPI. Tạo tài khoản TestPyPI tại đây và xác nhận địa chỉ email của bạn. Lưu ý rằng bạn sẽ có mật khẩu riêng để tải lên trang thử nghiệm và trang chính thức

Bước 12. Xuất bản lên TestPyPI

Quanh co

Sử dụng Twine để xuất bản an toàn gói của bạn lên TestPyPI. Nhập lệnh sau — không cần sửa đổi

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

5

Bạn sẽ được nhắc nhập tên người dùng và mật khẩu của mình. Hãy nhớ rằng, TestPyPI và PyPI có mật khẩu khác nhau

Nếu cần, sửa bất kỳ lỗi nào, tạo số phiên bản mới trong thiết lập. py và xóa các tạo phẩm xây dựng cũ. các thư mục build, dist và egg. Xây dựng lại bằng

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

4 và tải lên lại bằng Twine. Có số phiên bản trên TestPyPI không biểu thị bất cứ điều gì không phải là vấn đề lớn — bạn là người duy nhất sẽ sử dụng các phiên bản gói đó. 😄

Khi bạn đã tải lên thành công gói của mình, hãy đảm bảo rằng bạn có thể cài đặt và sử dụng gói đó

Bước 13. Xác minh cài đặt và sử dụng nó

Tạo một tab khác trong vỏ thiết bị đầu cuối của bạn và tạo một môi trường ảo khác

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

2

kích hoạt nó

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

3

Nếu bạn đã tải gói hàng của mình lên trang web PyPI chính thức thì bạn sẽ

.git
.gitignore 
LICENSE
README.rstnotebookc/__init__.py
notebookc/notebookc.py

9. Chúng tôi có thể truy xuất gói từ TestPypPI và cài đặt gói đó bằng lệnh đã sửa đổi

Dưới đây là hướng dẫn chính thức để cài đặt gói của bạn từ TestPyPI

Bạn có thể yêu cầu pip tải xuống các gói từ TestPyPI thay vì PyPI bằng cách chỉ định cờ — url chỉ mục

pip==19.0.3
wheel==0.33.1

0

Nếu bạn muốn cho phép pip kéo các gói khác từ PyPI, bạn có thể chỉ định — extra-index-url để trỏ đến PyPI. Điều này hữu ích khi gói bạn đang thử nghiệm có các thành phần phụ thuộc

pip==19.0.3
wheel==0.33.1

1

Nếu gói của bạn có phần phụ thuộc, hãy sử dụng lệnh thứ hai và thay thế tên gói của bạn

Bạn sẽ thấy phiên bản mới nhất của gói được cài đặt trong môi trường ảo của mình

Để xác minh rằng bạn có thể sử dụng gói của mình, hãy bắt đầu phiên IPython trong thiết bị đầu cuối của bạn với

pip==19.0.3
wheel==0.33.1

2

Nhập hàm của bạn và gọi hàm của bạn bằng đối số chuỗi. Đây là mã của tôi trông như thế nào

pip==19.0.3
wheel==0.33.1

3

pip==19.0.3
wheel==0.33.1

4

sau đó tôi thấy đầu ra này

pip==19.0.3
wheel==0.33.1

5

Chắc chắn bạn sẽ. 😉

Bước 14. Đẩy tới PyPI

Đẩy mã của bạn lên trang web PyPI thực để mọi người có thể tải xuống khi họ

pip==19.0.3
wheel==0.33.1

6

Đây là bạn tải lên mã của bạn

pip==19.0.3
wheel==0.33.1

7

Lưu ý rằng bạn cần cập nhật số phiên bản của mình trong thiết lập. py nếu bạn muốn đẩy phiên bản mới lên PyPI

Được rồi, hãy tải tác phẩm của chúng ta lên GitHub

Bước 15. Đẩy lên GitHub

Hãy chắc chắn rằng bạn đã cam kết mã của mình

Thư mục dự án notebookc của tôi trông như thế này

.git
.gitignore 
LICENSE
README.rst

9

Loại trừ mọi môi trường ảo mà bạn không muốn tải lên. con trăn. gitignore mà chúng tôi đã chọn khi tạo repo sẽ giữ cho các tạo phẩm xây dựng không bị lập chỉ mục. Bạn có thể cần xóa các thư mục môi trường ảo của mình

Đẩy chi nhánh địa phương của bạn lên GitHub với

pip==19.0.3
wheel==0.33.1

8

Bước 16. Tạo và hợp nhất PR

Từ trình duyệt của bạn, điều hướng đến GitHub. Bạn sẽ thấy một tùy chọn để thực hiện yêu cầu kéo. Tiếp tục nhấn các nút màu xanh lục để tạo và hợp nhất PR của bạn, đồng thời xóa nhánh tính năng từ xa của bạn

Quay lại thiết bị đầu cuối của bạn, xóa nhánh tính năng cục bộ của bạn bằng

pip==19.0.3
wheel==0.33.1

9

Bước 17. Cập nhật phiên bản phát hành trên GitHub

Tạo một phiên bản phát hành mới trên GitHub bằng cách nhấp vào các bản phát hành trên trang chính của kho lưu trữ. Nhập thông tin về bản phát hành và lưu

Điều đó tốt cho bây giờ. 🎉

Chúng tôi sẽ bổ sung thêm nhiều tệp và thư mục trong các bài viết sau

Hãy tóm tắt lại các bước của chúng tôi

Tóm tắt lại. 17 bước để có một gói làm việc

1. Lên kế hoạch
2. Gọi tên nó
3. Cấu hình môi trường
4. Tạo tổ chức trên Github
5. Thiết lập Kho lưu trữ GitHub
6. Sao chép và thêm thư mục
7. Tạo và cài đặt tests_dev. txt
8. Mã và cam kết
9. Tạo thiết lập. py
10. Xây dựng phiên bản đầu tiên
11. Tạo tài khoản TestPyPI
12. Đẩy tới TestPyPI
13. Xác minh cài đặt và sử dụng
14. Đẩy tới PyPI
15. Đẩy lên GitHub
16. Tạo và hợp nhất PR
17. Cập nhật phiên bản phát hành trên GitHub

Bọc

Tôi hy vọng bạn thấy hướng dẫn tạo và phát hành gói Python đầu tiên này hữu ích. Nếu bạn đã làm, vui lòng chia sẻ nó trên các kênh truyền thông xã hội yêu thích của bạn để những người khác cũng có thể tìm thấy nó. 👏

Trong phần tiếp theo của loạt bài này, chúng tôi sẽ thêm các thử nghiệm, tích hợp liên tục, phạm vi mã, v.v. Kiểm tra nó ra ở đây

10 bước để thiết lập dự án Python của bạn thành công

Cách thêm kiểm tra, CI, phạm vi mã, v.v.

hướng tới khoa học dữ liệu. com

Tôi viết về Python, Docker, khoa học dữ liệu và các chủ đề công nghệ khác. Nếu bạn quan tâm đến bất kỳ điều gì, hãy đọc thêm tại đây và theo dõi tôi trên Medium. 😄

Làm cách nào để tạo một dự án Python?

Tôi nên tổ chức dự án Python của mình như thế nào?