Lizenzen einbinden und READMEs schreiben

Python-Pakete entwickeln

James Fulton

Climate informatics researcher

Warum brauche ich eine Lizenz?

Damit andere deinen Code nutzen dürfen

Open-Source-Lizenzen

Mehr Infos findest du hier
Erlaube Nutzer:innen,
- dein Package zu verwenden
- dein Package zu ändern
- Versionen deines Packages zu verbreiten

¹ https://choosealicense.com

Was ist ein README?

Die „Startseite" deines Packages
Wird auf Github oder PyPI angezeigt

Was gehört in ein README

README-Bereiche

Titel
Beschreibung und Features
Installation
Anwendungsbeispiele
Beitrag leisten
Lizenz

README-Format

Markdown (commonmark)

In der Datei README.md
Einfacher
In diesem Kurs und allgemein verwendet

reStructuredText

In der Datei README.rst
Komplexer
Ebenfalls weit verbreitet

Commonmark

Inhalt von README.md

So sieht die gerenderte Ansicht aus

Commonmark

Inhalt von README.md

# mysklearn

mysklearn ist ein Package für vollständige 
**lineare Regression** in Python.


Mehr über dieses Package findest du 
auf [DataCamp](https://datacamp.com)

So sieht die gerenderte Ansicht aus

mysklearn

mysklearn ist ein Package für vollständige lineare Regression in python.

Mehr über dieses Package findest du auf DataCamp

Commonmark

Inhalt von README.md

# mysklearn

mysklearn ist ein Package für vollständige 
**lineare Regression** in Python.


Mehr über dieses Package findest du 
auf [DataCamp](https://datacamp.com)


## Installation
Du kannst dieses Package installieren mit

So sieht die gerenderte Ansicht aus

mysklearn

mysklearn ist ein Package für vollständige lineare Regression in python.

Mehr über dieses Package findest du auf DataCamp

Installation

Du kannst dieses Package installieren mit

Commonmark

Inhalt von README.md

# mysklearn
mysklearn ist ein Package für vollständige 
**lineare Regression** in Python.

Mehr über dieses Package findest du 
auf [DataCamp](https://datacamp.com)

## Installation
Du kannst dieses Package installieren mit

```
pip install mysklearn
```

So sieht die gerenderte Ansicht aus

mysklearn

mysklearn ist ein Package für vollständige lineare Regression in python.

Mehr über dieses Package findest du auf DataCamp

Installation

Du kannst dieses Package installieren mit

pip install mysklearn

Diese Dateien zu deinem Package hinzufügen

Verzeichnisbaum für ein Package mit Subpackages

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- neue Dateien
|-- README.md    <--- im Top-Verzeichnis hinzugefügt

MANIFEST.in

Listet alle zusätzlichen Dateien auf, die in die Paketdistribution aufgenommen werden sollen.

MANIFEST.in

Inhalt von MANIFEST.in

include LICENSE
include README.md

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

Lass uns üben!

Python-Pakete entwickeln