Version numbers and history

Developing Python Packages

James Fulton

Climate informatics researcher

Final files

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

Either markdown or reStructured-Text
Invites other developers to work on your package
Tells them how to get started

HISTORY.md

e.g. NumPy release notes

Known as history, changelog or release notes
Tells users what has changed between versions

HISTORY.md

Section for each released version
Bullet points of the important changes
Subsections for

# History


## 0.3.0






## 0.2.1



## 0.2.0

HISTORY.md

Section for each released version
Bullet points of the important changes
Subsections for
- Improvements to existing functions

# History

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




## 0.2.1



## 0.2.0

HISTORY.md

Section for each released version
Bullet points of the important changes
Subsections for
- Improvements to existing functions
- New additions

# 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

Section for each released version
Bullet points of the important changes
Subsections for
- Improvements to existing functions
- New additions
- Bugs that have been fixed

# 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

Section for each released version
Bullet points of the important changes
Subsections for
- Improvements to existing functions
- New additions
- Bugs that have been fixed
- Deprecations

# 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.

Version number

Increase version number when ready for new release
Cannot upload to PyPI if not changed

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

The package version number

setup.py

# Import required functions
from setuptools import setup, find_packages

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

)

Top level __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

Convenient tool to update all package version numbers

bumpversion major

bumpversion minor

bumpversion patch

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

Let's practice!

Developing Python Packages