Номера версий и история изменений

Разработка пакетов на 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

Известен как история изменений, 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
...

Давайте потренируемся!

Разработка пакетов на Python