Licencje i pliki README

Tworzenie pakietów w Pythonie

James Fulton

Climate informatics researcher

Po co licencja?

  • Aby umożliwić innym korzystanie z kodu
Tworzenie pakietów w Pythonie

Licencje open source

  • Więcej informacji tutaj
  • Pozwalają użytkownikom na
    • korzystanie z pakietu
    • modyfikowanie pakietu
    • dystrybucję wersji pakietu
1 https://choosealicense.com
Tworzenie pakietów w Pythonie

Czym jest README?

  • „Strona główna" pakietu
  • Wyświetlana na GitHubie lub PyPI
Tworzenie pakietów w Pythonie

Co zawrzeć w pliku README

Sekcje pliku README

  • Tytuł
  • Opis i funkcje
  • Instalacja
  • Przykłady użycia
  • Współtworzenie
  • Licencja
Tworzenie pakietów w Pythonie

Format pliku README

Markdown (commonmark)

  • Zawarty w pliku README.md
  • Prostszy
  • Używany w tym kursie i powszechnie
reStructuredText

  • Zawarty w pliku README.rst
  • Bardziej złożony
  • Również powszechnie stosowany
Tworzenie pakietów w Pythonie

Commonmark

Zawartość pliku README.md














`

Wygląd po renderowaniu

Tworzenie pakietów w Pythonie

Commonmark

Zawartość pliku 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)

Wygląd po renderowaniu

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Tworzenie pakietów w Pythonie

Commonmark

Zawartość pliku 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

Wygląd po renderowaniu

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

Tworzenie pakietów w Pythonie

Commonmark

Zawartość pliku 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
```

Wygląd po renderowaniu

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
Tworzenie pakietów w Pythonie

Dodawanie plików do pakietu

Drzewo katalogów pakietu z podpakietami

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- nowe pliki
|-- README.md    <--- dodane do głównego katalogu
Tworzenie pakietów w Pythonie

MANIFEST.in

Zawiera listę dodatkowych plików do uwzględnienia w dystrybucji pakietu.

Tworzenie pakietów w Pythonie

MANIFEST.in

Zawartość pliku MANIFEST.in

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---
Tworzenie pakietów w Pythonie

Czas na ćwiczenia!

Tworzenie pakietów w Pythonie

Preparing Video For Download...