Bao gồm giấy phép và viết README
Phát triển gói Python
James Fulton
Climate informatics researcher
Vì sao cần giấy phép?
- Để cho phép người khác dùng mã của bạn
Giấy phép mã nguồn mở
- Xem thêm thông tin tại đây
- Cho phép người dùng
- sử dụng gói của bạn
- sửa đổi gói của bạn
- phân phối các phiên bản của gói
README là gì?
- “Trang đầu” của gói
- Hiển thị trên Github hoặc PyPI
Cần có gì trong README
Các mục trong README
- Tiêu đề
- Mô tả và tính năng
- Cài đặt
- Ví dụ sử dụng
- Đóng góp
- Giấy phép
Định dạng README
Markdown (commonmark)
- Nằm trong tệp
README.md - Đơn giản hơn
- Dùng trong khóa học này và ngoài thực tế
reStructuredText
- Nằm trong tệp
README.rst - Phức tạp hơn
- Cũng phổ biến ngoài thực tế
Commonmark
Nội dung README.md
`
Khi hiển thị sẽ như sau
Commonmark
Nội dung README.md
# mysklearnmysklearn là một gói cho **hồi quy tuyến tính** đầy đủ trong Python.Quý vị có thể tìm hiểu thêm về gói này trên [DataCamp](https://datacamp.com)
Khi hiển thị sẽ như sau
mysklearn
mysklearn là một gói cho hồi quy tuyến tính trong python.
Quý vị có thể tìm hiểu thêm về gói này trên DataCamp
Commonmark
Nội dung README.md
# mysklearnmysklearn là một gói cho **hồi quy tuyến tính** đầy đủ trong Python.Quý vị có thể tìm hiểu thêm về gói này trên [DataCamp](https://datacamp.com)## Cài đặt Quý vị có thể cài gói này bằng
Khi hiển thị sẽ như sau
mysklearn
mysklearn là một gói cho hồi quy tuyến tính trong python.
Quý vị có thể tìm hiểu thêm về gói này trên DataCamp
Cài đặt
Quý vị có thể cài gói này bằng
Commonmark
Nội dung README.md
# mysklearn
mysklearn là một gói cho
**hồi quy tuyến tính** đầy đủ trong Python.
Quý vị có thể tìm hiểu thêm về gói này
trên [DataCamp](https://datacamp.com)
## Cài đặt
Quý vị có thể cài gói này bằng
```
pip install mysklearn
```
Khi hiển thị sẽ như sau
mysklearn
mysklearn là một gói cho hồi quy tuyến tính trong python.
Quý vị có thể tìm hiểu thêm về gói này trên DataCamp
Cài đặt
Quý vị có thể cài gói này bằng
pip install mysklearn
Thêm các tệp này vào gói của bạn
Cây thư mục cho gói có các gói con
mysklearn/
|-- mysklearn
| |-- __init__.py
| |-- preprocessing
| | |-- ...
| |-- regression
| | |-- ...
| |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE <--- tệp mới
|-- README.md <--- thêm ở thư mục gốc
MANIFEST.in
Liệt kê các tệp bổ sung cần đưa vào bản phân phối gói của bạn.
MANIFEST.in
Nội dung MANIFEST.in
include LICENSE
include README.md
mysklearn/
|-- mysklearn
| |-- __init__.py
| |-- preprocessing
| | |-- ...
| |-- regression
| | |-- ...
| |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in <---
Ayo berlatih!
Phát triển gói Python
