Номери версій і історія

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

  • Також «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...