版本号与历史

开发 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  <-- 新增文件
|-- HISTORY.md       <--
`-- Makefile

CONTRIBUTING.md

使用 Markdown 或 reStructuredText 均可
邀请其他开发者参与您的包
告知其如何开始

HISTORY.md

例如 NumPy 发布说明

又称历史、变更日志、发布说明
告知用户各版本间的变更

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/    <--   进入此目录
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...

Passons à la pratique !

开发 Python 包