バージョン番号と履歴

Pythonパッケージ開発

James Fulton

Climate informatics researcher

最終ファイル

CONTRIBUTING.md
HISTORY.md

mysklearn/
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- tests/
|   |-- __init__.py
|   `-- test_mysklearn.py
|-- MANIFEST.in
|-- README.md
|-- requirements_dev.txt
|-- setup.cfg
|-- setup.py
|-- tox.ini
|-- AUTHORS.md
|-- CONTRIBUTING.md  <-- new files
|-- HISTORY.md       <--
`-- Makefile

CONTRIBUTING.md

Markdown または reStructuredText のいずれか
他の開発者にコントリビュートを促す
開始手順を案内

HISTORY.md

例: NumPy のリリースノート

history, changelog, release notes とも呼ばれる
バージョン間の変更点を示す

HISTORY.md

各リリース版ごとにセクション
重要な変更点を箇条書き
小見出し例

# History


## 0.3.0






## 0.2.1



## 0.2.0

HISTORY.md

各リリース版ごとにセクション
重要な変更点を箇条書き
小見出し例:
- 既存関数の改良

# History

## 0.3.0
### Changed
- Regression fitting sped up using NumPy operations.




## 0.2.1



## 0.2.0

HISTORY.md

各リリース版ごとにセクション
重要な変更点を箇条書き
小見出し例:
- 既存関数の改良
- 新機能の追加

# History

## 0.3.0
### Changed
- Regression fitting sped up using NumPy operations.




## 0.2.1



## 0.2.0
### Added
- Multiple linear regression now available in new 
  `regression.multiple_regression` module.

HISTORY.md

各リリース版ごとにセクション
重要な変更点を箇条書き
小見出し例:
- 既存関数の改良
- 新機能の追加
- 修正された不具合

# History

## 0.3.0
### Changed
- Regression fitting sped up using NumPy operations.




## 0.2.1
### Fixed
- Fixed bug causing intercepts of zero.

## 0.2.0
### Added
- Multiple linear regression now available in new 
  `regression.multiple_regression` module.

HISTORY.md

各リリース版ごとにセクション
重要な変更点を箇条書き
小見出し例:
- 既存関数の改良
- 新機能の追加
- 修正された不具合
- 非推奨事項

# History

## 0.3.0
### Changed
- Regression fitting sped up using NumPy operations.
### Deprecated
- Support for Python 3.5 has ended.
- `regression.regression` module has been removed.

## 0.2.1
### Fixed
- Fixed bug causing intercepts of zero.

## 0.2.0
### Added
- Multiple linear regression now available in new 
  `regression.multiple_regression` module.
### Deprecated
- 0.2.x will be the last version that supports Python 3.5.
- `regression.regression` module has been renamed 
  `regression.single_regression`. `regression.regression` will be 
  removed in next minor release.

History

0.3.0

Changed

Regression fitting sped up using NumPy operations.

Deprecated

Support for Python 3.5 has ended.
regression.regression module has been removed.

0.2.1

Fixed

Fixed bug causing intercepts of zero.

0.2.0

Added

Multiple linear regression now available in new regression.multiple_regression module.

Deprecated

0.2.x will be the last version that supports Python 3.5.
regression.regression module has been renamed regression.single_regression. regression.regression will be removed in next minor release.

バージョン番号

新リリース時にバージョン番号を更新
変更しないと PyPI にアップロード不可

mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...

パッケージのバージョン番号

setup.py

# Import required functions
from setuptools import setup, find_packages

# Call setup function
setup(
    ...
    version='0.1.0',  <---
    ...

)

トップレベルの __init__.py

"""
Linear regression for Python
============================

mysklearn is a complete package for implmenting
linear regression in python. 
"""

__version__ = '0.1.0'  <---

print(mysklearn.__version__)

0.1.0

bumpversion

パッケージ内のバージョン番号を一括更新するツール

bumpversion major

bumpversion minor

bumpversion patch

mysklearn/    <--   navigate to here
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...

Ayo berlatih!

Pythonパッケージ開発