包含许可证并编写 README

开发 Python 包

James Fulton

Climate informatics researcher

为什么需要许可证？

授权他人使用您的代码

开源许可证

在此处了解更多信息
允许用户
- 使用你的包
- 修改你的包
- 分发你的包的版本

¹ https://choosealicense.com

什么是 README？

你的包的"首页"
显示在 Github 或 PyPI 上

README 包含哪些内容

README 的章节

标题
描述与特性
安装
使用示例
贡献
许可证

README 格式

Markdown（CommonMark）

放在 README.md 文件中
更简单
本课程与业界常用

reStructuredText

放在 README.rst 文件中
更复杂
在业界也常见

Commonmark

README.md 的内容

渲染后的效果

Commonmark

README.md 的内容

# mysklearn

mysklearn 是一个用于完成
Python 中**线性回归**的包。


在 [DataCamp](https://datacamp.com) 
了解更多关于此包的信息

渲染后的效果

mysklearn

mysklearn 是一个用于完成 python 中线性回归的包。

在 DataCamp 了解更多关于此包的信息

Commonmark

README.md 的内容

# mysklearn

mysklearn 是一个用于完成
Python 中**线性回归**的包。


在 [DataCamp](https://datacamp.com) 
了解更多关于此包的信息


## 安装
您可以使用以下方式安装此包

渲染后的效果

mysklearn

mysklearn 是一个用于完成 python 中线性回归的包。

在 DataCamp 了解更多关于此包的信息

安装

您可以使用以下方式安装此包

Commonmark

README.md 的内容

# mysklearn
mysklearn 是一个用于完成 
Python 中**线性回归**的包。

在 [DataCamp](https://datacamp.com) 
了解更多关于此包的信息

## 安装
您可以使用以下方式安装此包

```
pip install mysklearn
```

渲染后的效果

mysklearn

mysklearn 是一个用于完成 python 中线性回归的包。

在 DataCamp 了解更多关于此包的信息

安装

您可以使用以下方式安装此包

pip install mysklearn

将这些文件添加到你的包中

包含子包的目录结构

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- 新文件
|-- README.md    <--- 添加到顶层目录

MANIFEST.in

列出要包含在包分发中的所有额外文件。

MANIFEST.in

MANIFEST.in 的内容

include LICENSE
include README.md

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

Passons à la pratique !

开发 Python 包