Додавання ліцензій і написання README

Розроблення пакетів Python

James Fulton

Climate informatics researcher

Навіщо мені ліцензія?

  • Щоб надати іншим дозвіл використовувати ваш код
Розроблення пакетів Python

Ліцензії з відкритим кодом

  • Більше інформації тут
  • Дозвольте користувачам
    • використовувати ваш пакет
    • змінювати ваш пакет
    • розповсюджувати версії вашого пакета
1 https://choosealicense.com
Розроблення пакетів Python

Що таке README?

  • «Головна сторінка» вашого пакета
  • Показується на Github або PyPI
Розроблення пакетів Python

Що додати до README

Розділи README

  • Заголовок
  • Опис і можливості
  • Встановлення
  • Приклади використання
  • Участь у розробці
  • Ліцензія
Розроблення пакетів Python

Формат README

Markdown (commonmark)

  • У файлі README.md
  • Простішій
  • Використовується в цьому курсі та загалом
reStructuredText

  • У файлі README.rst
  • Складніший
  • Також поширений
Розроблення пакетів Python

Commonmark

Вміст README.md














`

Як це виглядає після рендерингу

Розроблення пакетів Python

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

Розроблення пакетів Python

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

Розроблення пакетів Python

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
Розроблення пакетів Python

Додавання цих файлів до вашого пакета

Дерево каталогу для пакета з підпакетами

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- нові файли
|-- README.md    <--- додано у верхній каталог
Розроблення пакетів Python

MANIFEST.in

Перелічує всі додаткові файли, які слід включити до дистрибутиву пакета.

Розроблення пакетів Python

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

Давайте потренуємось!

Розроблення пакетів Python

Preparing Video For Download...