Versionsnummer och historik

Att utveckla Python-paket

James Fulton

Climate informatics researcher

Slutliga filer

  • 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
Att utveckla Python-paket

CONTRIBUTING.md

  • Markdown eller reStructuredText
  • Bjuder in andra utvecklare att bidra till paketet
  • Beskriver hur de kommer igång
Att utveckla Python-paket

HISTORY.md

t.ex. NumPy release notes

  • Kallas historik, ändringslogg eller versionsinformation
  • Beskriver vad som förändrats mellan versioner
Att utveckla Python-paket

HISTORY.md

  • Avsnitt för varje utgiven version
  • Punktlista med viktiga ändringar
  • Underavsnitt för
# History

## 0.3.0 ## 0.2.1 ## 0.2.0
Att utveckla Python-paket

HISTORY.md

  • Avsnitt för varje utgiven version
  • Punktlista med viktiga ändringar
  • Underavsnitt för
    • Förbättringar av befintliga funktioner
# History

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




## 0.2.1



## 0.2.0











Att utveckla Python-paket

HISTORY.md

  • Avsnitt för varje utgiven version
  • Punktlista med viktiga ändringar
  • Underavsnitt för
    • Förbättringar av befintliga funktioner
    • Nya tillägg
# 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.








Att utveckla Python-paket

HISTORY.md

  • Avsnitt för varje utgiven version
  • Punktlista med viktiga ändringar
  • Underavsnitt för
    • Förbättringar av befintliga funktioner
    • Nya tillägg
    • Åtgärdade buggar
# 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.








Att utveckla Python-paket

HISTORY.md

  • Avsnitt för varje utgiven version
  • Punktlista med viktiga ändringar
  • Underavsnitt för
    • Förbättringar av befintliga funktioner
    • Nya tillägg
    • Åtgärdade buggar
    • Utfasningar
# 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.


Att utveckla Python-paket

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.
Att utveckla Python-paket

Versionsnummer

  • Öka versionsnumret inför ny release
  • Kan inte laddas upp till PyPI utan ändring
mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...
Att utveckla Python-paket

Paketets versionsnummer

setup.py

# Import required functions
from setuptools import setup, find_packages

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

)

Översta nivåns __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
Att utveckla Python-paket

bumpversion

  • Praktiskt verktyg för att uppdatera alla versionsnummer
bumpversion major
bumpversion minor
bumpversion patch
mysklearn/    <--   navigate to here
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...
Att utveckla Python-paket

Nu kör vi en övning!

Att utveckla Python-paket

Preparing Video For Download...