Números de versão e histórico

Desenvolvendo pacotes Python

James Fulton

Climate informatics researcher

Arquivos finais

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  <-- novos arquivos
|-- HISTORY.md       <--
`-- Makefile

CONTRIBUTING.md

Pode ser Markdown ou reStructuredText
Convida outros desenvolvedores a colaborar
Explica como começar

HISTORY.md

ex.: Notas de versão do NumPy

Conhecido como histórico, changelog ou notas de versão
Informa o que mudou entre versões

HISTORY.md

Seção para cada versão lançada
Tópicos com as mudanças importantes
Subseções para

# History


## 0.3.0






## 0.2.1



## 0.2.0

HISTORY.md

Seção para cada versão lançada
Tópicos com as mudanças importantes
Subseções para
- Melhorias em funções existentes

# History

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




## 0.2.1



## 0.2.0

HISTORY.md

Seção para cada versão lançada
Tópicos com as mudanças importantes
Subseções para
- Melhorias em funções existentes
- Novidades

# 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

Seção para cada versão lançada
Tópicos com as mudanças importantes
Subseções para
- Melhorias em funções existentes
- Novidades
- Correções de bugs

# 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

Seção para cada versão lançada
Tópicos com as mudanças importantes
Subseções para
- Melhorias em funções existentes
- Novidades
- Correções de bugs
- Descontinuações

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

Número de versão

Aumente a versão ao preparar um novo release
Não é possível enviar ao PyPI se não mudar

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

O número de versão do pacote

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

Ferramenta prática para atualizar todas as versões do pacote

bumpversion major

bumpversion minor

bumpversion patch

mysklearn/    <--   navegue até aqui
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...

Vamos praticar!

Desenvolvendo pacotes Python