ライセンスの追加とREADMEの作成
Pythonパッケージ開発
James Fulton
Climate informatics researcher
なぜライセンスが必要か
- 他者にコードの利用許可を与えるため
オープンソースライセンス
- さらに詳しくはこちら
- 利用者に以下を許可
- パッケージの使用
- パッケージの改変
- パッケージの再配布
1 https://choosealicense.com
READMEとは
- パッケージの「トップページ」
- Github や PyPI に表示
READMEに含める内容
READMEの主な項目
- タイトル
- 説明と機能
- インストール
- 使用例
- 貢献方法
- ライセンス
READMEの形式
Markdown（CommonMark）
README.mdに記載- より簡潔
- 本コースおよび一般で使用
reStructuredText
README.rstに記載- より複雑
- こちらも一般的
CommonMark
README.md の中身
`
レンダリング後の見た目
CommonMark
README.md の中身
# mysklearnmysklearn は、Python で完全な **線形回帰**を行うパッケージです。このパッケージの詳細は [DataCamp](https://datacamp.com) を参照
CommonMark
README.md の中身
# mysklearnmysklearn は、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 <---
Ayo berlatih!
Pythonパッケージ開発
