Přidávání licencí a psaní souborů README

Developing Python Packages

James Fulton

Climate informatics researcher

Proč potřebuji licenci?

  • Umožnit ostatním používat váš kód
Developing Python Packages

Open source licence

  • Více informací naleznete zde
  • Umožňují uživatelům
    • používat váš balíček
    • upravovat váš balíček
    • šířit verze vašeho balíčku
1 https://choosealicense.com
Developing Python Packages

Co je soubor README?

  • „Úvodní stránka" vašeho balíčku
  • Zobrazuje se na GitHubu nebo PyPI
Developing Python Packages

Co zahrnout do souboru README

Sekce souboru README

  • Název
  • Popis a funkce
  • Instalace
  • Příklady použití
  • Příspívání
  • Licence
Developing Python Packages

Formát souboru README

Markdown (commonmark)

  • Obsažen v souboru README.md
  • Jednodušší
  • Používán v tomto kurzu i v praxi
reStructuredText

  • Obsažen v souboru README.rst
  • Složitější
  • Také běžně používán v praxi
Developing Python Packages

Commonmark

Obsah souboru README.md














`

Výsledný vzhled po vykreslení

Developing Python Packages

Commonmark

Obsah souboru 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)

Výsledný vzhled po vykreslení

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Developing Python Packages

Commonmark

Obsah souboru 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

Výsledný vzhled po vykreslení

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

Developing Python Packages

Commonmark

Obsah souboru 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
```

Výsledný vzhled po vykreslení

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
Developing Python Packages

Přidání těchto souborů do balíčku

Adresářová struktura balíčku s podbalíčky

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- nové soubory
|-- README.md    <--- přidány do kořenového adresáře
Developing Python Packages

MANIFEST.in

Obsahuje seznam všech dodatečných souborů zahrnutých do distribuce balíčku.

Developing Python Packages

MANIFEST.in

Obsah souboru MANIFEST.in

include LICENSE
include README.md

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

Lass uns üben!

Developing Python Packages

Preparing Video For Download...