Versionsnummern und Verlauf

Python-Pakete entwickeln

James Fulton

Climate informatics researcher

Abschlussdateien

  • 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  <-- neue Dateien
|-- HISTORY.md       <--
`-- Makefile
Python-Pakete entwickeln

CONTRIBUTING.md

  • Entweder Markdown oder reStructuredText
  • Lädt andere Entwickler ein, an deinem Paket mitzuarbeiten
  • Erklärt, wie sie starten
Python-Pakete entwickeln

HISTORY.md

z. B. NumPy Release Notes

  • Auch bekannt als History, Changelog oder Release Notes
  • Sagt Nutzer:innen, was sich zwischen Versionen geändert hat
Python-Pakete entwickeln

HISTORY.md

  • Abschnitt für jede veröffentlichte Version
  • Aufzählung der wichtigsten Änderungen
  • Unterabschnitte für
# History

## 0.3.0 ## 0.2.1 ## 0.2.0
Python-Pakete entwickeln

HISTORY.md

  • Abschnitt für jede veröffentlichte Version
  • Aufzählung der wichtigsten Änderungen
  • Unterabschnitte für
    • Verbesserungen vorhandener Funktionen
# History

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




## 0.2.1



## 0.2.0











Python-Pakete entwickeln

HISTORY.md

  • Abschnitt für jede veröffentlichte Version
  • Aufzählung der wichtigsten Änderungen
  • Unterabschnitte für
    • Verbesserungen vorhandener Funktionen
    • Neue Ergänzungen
# 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-Pakete entwickeln

HISTORY.md

  • Abschnitt für jede veröffentlichte Version
  • Aufzählung der wichtigsten Änderungen
  • Unterabschnitte für
    • Verbesserungen vorhandener Funktionen
    • Neue Ergänzungen
    • Behobene 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-Pakete entwickeln

HISTORY.md

  • Abschnitt für jede veröffentlichte Version
  • Aufzählung der wichtigsten Änderungen
  • Unterabschnitte für
    • Verbesserungen vorhandener Funktionen
    • Neue Ergänzungen
    • Behobene Bugs
    • 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.


Python-Pakete entwickeln

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-Pakete entwickeln

Versionsnummer

  • Erhöhe die Versionsnummer, wenn ein neues Release ansteht
  • Upload zu PyPI geht nicht ohne Änderung
mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...
Python-Pakete entwickeln

Die Paket-Versionsnummer

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-Pakete entwickeln

bumpversion

  • Praktisches Tool, um alle Paket-Versionsnummern zu aktualisieren
bumpversion major
bumpversion minor
bumpversion patch
mysklearn/    <--   hierhin navigieren
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...
Python-Pakete entwickeln

Lass uns üben!

Python-Pakete entwickeln

Preparing Video For Download...