Lisans ekleme ve README yazma

Python Paketleri Geliştirme

James Fulton

Climate informatics researcher

Neden bir lisansa ihtiyacım var?

  • Başkalarına kodunuzu kullanma izni vermek için
Python Paketleri Geliştirme

Açık kaynak lisansları

  • Daha fazla bilgi için buraya bakınız
  • Kullanıcıların şunları yapmasına izin verin
    • paketinizı kullanma
    • paketinizı değiştirme
    • paketinizın sürümlerini dağıtma
1 https://choosealicense.com
Python Paketleri Geliştirme

README nedir?

  • Paketinizin “ön sayfası”
  • Github veya PyPI'de görüntülenir
Python Paketleri Geliştirme

README'ye neler eklenir

README bölümleri

  • Başlık
  • Açıklama ve Özellikler
  • Kurulum
  • Kullanım örnekleri
  • Katkıda bulunma
  • Lisans
Python Paketleri Geliştirme

README biçimi

Markdown (commonmark)

  • README.md dosyasında yer alır
  • Daha basit
  • Bu derste ve yaygın kullanımda
reStructuredText

  • README.rst dosyasında yer alır
  • Daha karmaşık
  • Yaygın olarak kullanılır
Python Paketleri Geliştirme

Commonmark

README.md içeriği














`

İşlendiğinde görünümü

Python Paketleri Geliştirme

Commonmark

README.md içeriği

# mysklearn

mysklearn, Python'da tam
**doğrusal regresyon** için bir pakettir.


Bu paket hakkında daha fazlasını 
[DataCamp](https://datacamp.com) üzerinde bulabilirsiniz

İşlendiğinde görünümü

mysklearn

mysklearn, Python'da tam doğrusal regresyon için bir pakettir.

Bu paket hakkında daha fazlasını DataCamp üzerinde bulabilirsiniz

Python Paketleri Geliştirme

Commonmark

README.md içeriği

# mysklearn

mysklearn, Python'da tam
**doğrusal regresyon** için bir pakettir.


Bu paket hakkında daha fazlasını 
[DataCamp](https://datacamp.com) üzerinde bulabilirsiniz


## Kurulum
Bu paketi aşağıdakini kullanarak kurabilirsiniz

İşlendiğinde görünümü

mysklearn

mysklearn, Python'da tam doğrusal regresyon için bir pakettir.

Bu paket hakkında daha fazlasını DataCamp üzerinde bulabilirsiniz

Kurulum

Bu paketi aşağıdakini kullanarak kurabilirsiniz

Python Paketleri Geliştirme

Commonmark

README.md içeriği

# mysklearn
mysklearn, Python'da tam 
**doğrusal regresyon** için bir pakettir.

Bu paket hakkında daha fazlasını 
[DataCamp](https://datacamp.com) üzerinde bulabilirsiniz

## Kurulum
Bu paketi aşağıdakini kullanarak kurabilirsiniz

```
pip install mysklearn
```

İşlendiğinde görünümü

mysklearn

mysklearn, Python'da tam doğrusal regresyon için bir pakettir.

Bu paket hakkında daha fazlasını DataCamp üzerinde bulabilirsiniz

Kurulum

Bu paketi aşağıdakini kullanarak kurabilirsiniz

pip install mysklearn
Python Paketleri Geliştirme

Bu dosyaları paketinize ekleme

Alt paketlere sahip paket için dizin ağacı

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- yeni dosyalar
|-- README.md    <--- üst dizine eklendi
Python Paketleri Geliştirme

MANIFEST.in

Paket dağıtımınıza dahil edilecek ek dosyaların tümünü listeler.

Python Paketleri Geliştirme

MANIFEST.in

MANIFEST.in içeriği

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---
Python Paketleri Geliştirme

Ayo berlatih!

Python Paketleri Geliştirme

Preparing Video For Download...