Menyertakan lisensi dan menulis README
Mengembangkan Paket Python
James Fulton
Climate informatics researcher
Mengapa saya butuh lisensi?
- Untuk memberi izin orang lain menggunakan kode Anda
Lisensi open source
- Cari info lebih lanjut di sini
- Mengizinkan pengguna untuk
- menggunakan paket Anda
- memodifikasi paket Anda
- mendistribusikan versi paket Anda
Apa itu README?
- "Halaman depan" paket Anda
- Ditampilkan di Github atau PyPI
Apa yang dicantumkan di README
Bagian README
- Judul
- Deskripsi dan Fitur
- Instalasi
- Contoh penggunaan
- Kontribusi
- Lisensi
Format README
Markdown (commonmark)
- Ada di file
README.md - Lebih sederhana
- Dipakai di kursus ini dan secara umum
reStructuredText
- Ada di file
README.rst - Lebih kompleks
- Juga umum digunakan
Commonmark
Isi README.md
`
Tampilan saat dirender
Commonmark
Isi README.md
# mysklearnmysklearn adalah paket untuk **regresi linear** lengkap di Python.Pelajari lebih lanjut tentang paket ini di [DataCamp](https://datacamp.com)
Tampilan saat dirender
mysklearn
mysklearn adalah paket untuk regresi linear lengkap di python.
Pelajari lebih lanjut tentang paket ini di DataCamp
Commonmark
Isi README.md
# mysklearnmysklearn adalah paket untuk **regresi linear** lengkap di Python.Pelajari lebih lanjut tentang paket ini di [DataCamp](https://datacamp.com)## Instalasi Anda dapat memasang paket ini dengan
Tampilan saat dirender
mysklearn
mysklearn adalah paket untuk regresi linear lengkap di python.
Pelajari lebih lanjut tentang paket ini di DataCamp
Instalasi
Anda dapat memasang paket ini dengan
Commonmark
Isi README.md
# mysklearn
mysklearn adalah paket untuk
**regresi linear** lengkap di Python.
Pelajari lebih lanjut tentang paket ini
di [DataCamp](https://datacamp.com)
## Instalasi
Anda dapat memasang paket ini dengan
```
pip install mysklearn
```
Tampilan saat dirender
mysklearn
mysklearn adalah paket untuk regresi linear lengkap di python.
Pelajari lebih lanjut tentang paket ini di DataCamp
Instalasi
Anda dapat memasang paket ini dengan
pip install mysklearn
Menambahkan file ini ke paket Anda
Pohon direktori untuk paket dengan subpaket
mysklearn/
|-- mysklearn
| |-- __init__.py
| |-- preprocessing
| | |-- ...
| |-- regression
| | |-- ...
| |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE <--- file baru
|-- README.md <--- ditambahkan ke direktori atas
MANIFEST.in
Mencantumkan semua file ekstra untuk disertakan dalam distribusi paket Anda.
MANIFEST.in
Isi 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!
Mengembangkan Paket Python
