Čísla verzí a historie

Developing Python Packages

James Fulton

Climate informatics researcher

Výsledné soubory

  • 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
Developing Python Packages

CONTRIBUTING.md

  • Markdown nebo reStructuredText
  • Zve další vývojáře ke spolupráci na balíčku
  • Vysvětluje, jak začít
Developing Python Packages

HISTORY.md

např. poznámky k vydání NumPy

  • Označováno jako historie, changelog nebo poznámky k vydání
  • Informuje uživatele o změnách mezi verzemi
Developing Python Packages

HISTORY.md

  • Sekce pro každou vydanou verzi
  • Odrážky s důležitými změnami
  • Podsekce pro
# History

## 0.3.0 ## 0.2.1 ## 0.2.0
Developing Python Packages

HISTORY.md

  • Sekce pro každou vydanou verzi
  • Odrážky s důležitými změnami
  • Podsekce pro
    • Vylepšení stávajících funkcí
# History

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




## 0.2.1



## 0.2.0











Developing Python Packages

HISTORY.md

  • Sekce pro každou vydanou verzi
  • Odrážky s důležitými změnami
  • Podsekce pro
    • Vylepšení stávajících funkcí
    • Nové přírůstky
# 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.








Developing Python Packages

HISTORY.md

  • Sekce pro každou vydanou verzi
  • Odrážky s důležitými změnami
  • Podsekce pro
    • Vylepšení stávajících funkcí
    • Nové přírůstky
    • Opravené chyby
# 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.








Developing Python Packages

HISTORY.md

  • Sekce pro každou vydanou verzi
  • Odrážky s důležitými změnami
  • Podsekce pro
    • Vylepšení stávajících funkcí
    • Nové přírůstky
    • Opravené chyby
    • Zastaralé prvky
# 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.


Developing Python Packages

Historie

0.3.0

Změněno
  • Regresní fitting byl urychlen pomocí operací NumPy.
Zastaralé
  • Podpora pro Python 3.5 skončila.
  • Modul regression.regression byl odstraněn.

0.2.1

Opraveno
  • Opravena chyba způsobující nulové intercepty.

0.2.0

Přidáno
  • Vícenásobná lineární regrese je nyní dostupná v novém modulu regression.multiple_regression.

    Zastaralé
  • 0.2.x bude poslední verzí s podporou Pythonu 3.5.

  • Modul regression.regression byl přejmenován na regression.single_regression. Modul regression.regression bude odstraněn v příští vedlejší verzi.
Developing Python Packages

Číslo verze

  • Zvyšte číslo verze před novým vydáním
  • Bez změny nelze nahrát na PyPI
mysklearn/
|-- mysklearn/
|   |-- __init__.py         <---
|   `-- mysklearn.py
|-- setup.py                <---
...
Developing Python Packages

Číslo verze balíčku

setup.py

# Import required functions
from setuptools import setup, find_packages

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

)

Hlavní __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
Developing Python Packages

bumpversion

  • Praktický nástroj pro aktualizaci čísla verze balíčku
bumpversion major
bumpversion minor
bumpversion patch
mysklearn/    <--   navigate to here
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...
Developing Python Packages

Pojďme si procvičit!

Developing Python Packages

Preparing Video For Download...