版本號與變更歷史

開發 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
開發 Python 套件

CONTRIBUTING.md

  • 可用 markdown 或 reStructured-Text
  • 邀請其他開發者參與你的套件
  • 告訴他們如何開始貢獻
開發 Python 套件

HISTORY.md

例如 NumPy release notes

  • 又稱 history、changelog 或 release notes
  • 告訴使用者各版本之間的變更
開發 Python 套件

HISTORY.md

  • 每個發行版本各一節
  • 以條列列出重要變更
  • 可包含子章節
# History


## 0.3.0






## 0.2.1



## 0.2.0
開發 Python 套件

HISTORY.md

  • 每個發行版本各一節
  • 以條列列出重要變更
  • 子章節包含：
    • 既有函式的改進
# History

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




## 0.2.1



## 0.2.0
開發 Python 套件

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.
開發 Python 套件

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.
開發 Python 套件

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.
開發 Python 套件

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.
開發 Python 套件

版本號碼

  • 準備發佈新版本時要提高版本號
  • 若未變更，無法上傳到 PyPI
mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...
開發 Python 套件

套件版本號

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
開發 Python 套件

bumpversion

  • 方便的工具，可一次更新所有套件版本號
bumpversion major

bumpversion minor

bumpversion patch

mysklearn/    <--   請切換到此目錄
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...
開發 Python 套件

一起來練習吧！

開發 Python 套件

Preparing Video For Download...