Versienummers en geschiedenis

Python-pakketten ontwikkelen

James Fulton

Climate informatics researcher

Eindbestanden

  • 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  <-- nieuwe bestanden
|-- HISTORY.md       <--
`-- Makefile
Python-pakketten ontwikkelen

CONTRIBUTING.md

  • Markdown of reStructuredText
  • Nodigt andere ontwikkelaars uit om mee te werken aan je pakket
  • Legt uit hoe ze starten
Python-pakketten ontwikkelen

HISTORY.md

bijv. NumPy-releasenotes

  • Ook wel history, changelog of releasenotes
  • Vertelt wat er tussen versies is veranderd
Python-pakketten ontwikkelen

HISTORY.md

  • Sectie per uitgebrachte versie
  • Opsomming van belangrijke wijzigingen
  • Subsecties voor
# History

## 0.3.0 ## 0.2.1 ## 0.2.0
Python-pakketten ontwikkelen

HISTORY.md

  • Sectie per uitgebrachte versie
  • Opsomming van belangrijke wijzigingen
  • Subsecties voor
    • Verbeteringen aan bestaande functies
# History

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




## 0.2.1



## 0.2.0











Python-pakketten ontwikkelen

HISTORY.md

  • Sectie per uitgebrachte versie
  • Opsomming van belangrijke wijzigingen
  • Subsecties voor
    • Verbeteringen aan bestaande functies
    • Nieuwe toevoegingen
# 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-pakketten ontwikkelen

HISTORY.md

  • Sectie per uitgebrachte versie
  • Opsomming van belangrijke wijzigingen
  • Subsecties voor
    • Verbeteringen aan bestaande functies
    • Nieuwe toevoegingen
    • Opgeloste 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.








Python-pakketten ontwikkelen

HISTORY.md

  • Sectie per uitgebrachte versie
  • Opsomming van belangrijke wijzigingen
  • Subsecties voor
    • Verbeteringen aan bestaande functies
    • Nieuwe toevoegingen
    • Opgeloste bugs
    • Verouderingen
# 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-pakketten ontwikkelen

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-pakketten ontwikkelen

Versienummer

  • Verhoog het versienummer bij een nieuwe release
  • Upload naar PyPI kan niet zonder wijziging
mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...
Python-pakketten ontwikkelen

Het pakketversienummer

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
Python-pakketten ontwikkelen

bumpversion

  • Handige tool om alle versienummers bij te werken
bumpversion major
bumpversion minor
bumpversion patch
mysklearn/    <--   navigeer hierheen
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...
Python-pakketten ontwikkelen

Laten we oefenen!

Python-pakketten ontwikkelen

Preparing Video For Download...