Inkludera licenser och skriv README-filer

Att utveckla Python-paket

James Fulton

Climate informatics researcher

Varför behöver jag en licens?

  • För att ge andra tillåtelse att använda din kod
Att utveckla Python-paket

Öppen källkod-licenser

  • Mer information här
  • Tillåter användare att
    • använda ditt paket
    • modifiera ditt paket
    • distribuera versioner av ditt paket
1 https://choosealicense.com
Att utveckla Python-paket

Vad är en README?

  • "Framsidan" på ditt paket
  • Visas på Github eller PyPI
Att utveckla Python-paket

Vad ska ingå i en README?

README-avsnitt

  • Titel
  • Beskrivning och funktioner
  • Installation
  • Användningsexempel
  • Bidra
  • Licens
Att utveckla Python-paket

README-format

Markdown (commonmark)

  • Finns i filen README.md
  • Enklare
  • Används i den här kursen och i praktiken
reStructuredText

  • Finns i filen README.rst
  • Mer komplex
  • Också vanlig i praktiken
Att utveckla Python-paket

Commonmark

Innehåll i README.md














`

Så här ser det ut när det renderas

Att utveckla Python-paket

Commonmark

Innehåll i 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)

Så här ser det ut när det renderas

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Att utveckla Python-paket

Commonmark

Innehåll i 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

Så här ser det ut när det renderas

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

Att utveckla Python-paket

Commonmark

Innehåll i 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
```

Så här ser det ut när det renderas

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
Att utveckla Python-paket

Lägg till filerna i ditt paket

Katalogträd för paket med underpaket

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- new files
|-- README.md    <--- added to top directory
Att utveckla Python-paket

MANIFEST.in

Listar alla extrafiler som ska ingå i paketdistributionen.

Att utveckla Python-paket

MANIFEST.in

Innehåll i MANIFEST.in

include LICENSE
include README.md

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

Nu kör vi en övning!

Att utveckla Python-paket

Preparing Video For Download...