การใส่ใบอนุญาตและการเขียน README

การพัฒนา Python Packages

James Fulton

Climate informatics researcher

ทำไมต้องมีใบอนุญาต?

เพื่อให้สิทธิ์ผู้อื่นในการใช้โค้ดของคุณ

ใบอนุญาตโอเพนซอร์ส

ดูข้อมูลเพิ่มเติมได้ที่ here
อนุญาตให้ผู้ใช้
- ใช้งานแพ็กเกจของคุณ
- แก้ไขแพ็กเกจของคุณ
- แจกจ่ายแพ็กเกจของคุณ

¹ https://choosealicense.com

README คืออะไร?

"หน้าปก" ของแพ็กเกจ
แสดงบน Github หรือ PyPI

สิ่งที่ควรมีใน README

ส่วนประกอบของ README

ชื่อ
คำอธิบายและฟีเจอร์
การติดตั้ง
ตัวอย่างการใช้งาน
การมีส่วนร่วม
ใบอนุญาต

รูปแบบ README

Markdown (commonmark)

บันทึกในไฟล์ README.md
ใช้งานง่ายกว่า
ใช้ในคอร์สนี้และในโปรเจกต์จริง

reStructuredText

บันทึกในไฟล์ README.rst
ซับซ้อนกว่า
พบได้ทั่วไปในโปรเจกต์จริงเช่นกัน

Commonmark

เนื้อหาใน README.md

ลักษณะเมื่อเรนเดอร์แล้ว

Commonmark

เนื้อหาใน README.md

# mysklearn

mysklearn is a package for complete 
**linear regression** in Python.


You can find out more about this package 
on [DataCamp](https://datacamp.com)

ลักษณะเมื่อเรนเดอร์แล้ว

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Commonmark

เนื้อหาใน README.md

# mysklearn

mysklearn is a package for complete 
**linear regression** in Python.


You can find out more about this package 
on [DataCamp](https://datacamp.com)


## Installation
You can install this package using

ลักษณะเมื่อเรนเดอร์แล้ว

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Installation

You can install this package using

Commonmark

เนื้อหาใน README.md

# mysklearn
mysklearn is a package for complete 
**linear regression** in Python.

You can find out more about this package 
on [DataCamp](https://datacamp.com)

## Installation
You can install this package using

```
pip install mysklearn
```

ลักษณะเมื่อเรนเดอร์แล้ว

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Installation

You can install this package using

pip install mysklearn

การเพิ่มไฟล์เหล่านี้ลงในแพ็กเกจ

โครงสร้างไดเรกทอรีของแพ็กเกจที่มีซับแพ็กเกจ

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- new files
|-- README.md    <--- added to top directory

MANIFEST.in

ระบุไฟล์เพิ่มเติมทั้งหมดที่ต้องการรวมในการแจกจ่ายแพ็กเกจ

MANIFEST.in

เนื้อหาของ MANIFEST.in

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---

มาฝึกกันเถอะ!

การพัฒนา Python Packages