Includerea licențelor și scrierea fișierelor README

Dezvoltarea pachetelor Python

James Fulton

Climate informatics researcher

De ce am nevoie de o licență?

  • Pentru a oferi altora permisiunea de a utiliza codul dumneavoastră
Dezvoltarea pachetelor Python

Licențe open source

  • Mai multe informații aici
  • Permit utilizatorilor să
    • utilizeze pachetul dumneavoastră
    • modifice pachetul dumneavoastră
    • distribuie versiuni ale pachetului dumneavoastră
1 https://choosealicense.com
Dezvoltarea pachetelor Python

Ce este un README?

  • „Pagina principală" a pachetului dumneavoastră
  • Afișat pe Github sau PyPI
Dezvoltarea pachetelor Python

Ce să includeți într-un README

Secțiunile README

  • Titlu
  • Descriere și funcționalități
  • Instalare
  • Exemple de utilizare
  • Contribuție
  • Licență
Dezvoltarea pachetelor Python

Formatul README

Markdown (commonmark)

  • Conținut în fișierul README.md
  • Mai simplu
  • Utilizat în acest curs și în practică
reStructuredText

  • Conținut în fișierul README.rst
  • Mai complex
  • De asemenea comun în practică
Dezvoltarea pachetelor Python

Commonmark

Conținutul fișierului README.md














`

Cum arată după randare

Dezvoltarea pachetelor Python

Commonmark

Conținutul fișierului 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)

Cum arată după randare

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Dezvoltarea pachetelor Python

Commonmark

Conținutul fișierului 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

Cum arată după randare

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

Dezvoltarea pachetelor Python

Commonmark

Conținutul fișierului 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
```

Cum arată după randare

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
Dezvoltarea pachetelor Python

Adăugarea acestor fișiere în pachet

Arborele de directoare pentru un pachet cu subpachete

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- fișiere noi
|-- README.md    <--- adăugate în directorul principal
Dezvoltarea pachetelor Python

MANIFEST.in

Listează toate fișierele suplimentare de inclus în distribuția pachetului.

Dezvoltarea pachetelor Python

MANIFEST.in

Conținutul fișierului MANIFEST.in

include LICENSE
include README.md

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

Să exersăm!

Dezvoltarea pachetelor Python

Preparing Video For Download...