Numéros de version et historique

Créer des paquetages Python

James Fulton

Climate informatics researcher

Fichiers finaux

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  <-- nouveaux fichiers
|-- HISTORY.md       <--
`-- Makefile

CONTRIBUTING.md

En Markdown ou reStructuredText
Invite d'autres développeurs à contribuer à votre paquet
Explique comment démarrer

HISTORY.md

p. ex. notes de version de NumPy

Aussi appelé historique, journal des changements ou notes de version
Indique aux utilisateurs ce qui a changé entre les versions

HISTORY.md

Une section par version publiée
Points clés des changements importants
Sous-sections pour

# History


## 0.3.0






## 0.2.1



## 0.2.0

HISTORY.md

Une section par version publiée
Points clés des changements importants
Sous-sections pour
- Améliorations aux fonctions existantes

# History

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




## 0.2.1



## 0.2.0

HISTORY.md

Une section par version publiée
Points clés des changements importants
Sous-sections pour
- Améliorations aux fonctions existantes
- Nouveautés

# 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

Une section par version publiée
Points clés des changements importants
Sous-sections pour
- Améliorations aux fonctions existantes
- Nouveautés
- Corrections de bogues

# 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

Une section par version publiée
Points clés des changements importants
Sous-sections pour
- Améliorations aux fonctions existantes
- Nouveautés
- Corrections de bogues
- Dépréciations

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

Numéro de version

Augmentez le numéro de version avant une nouvelle parution
Téléversement vers PyPI impossible si inchangé

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

Le numéro de version du paquet

setup.py

# Import required functions
from setuptools import setup, find_packages

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

)

Fichier __init__.py à la racine

"""
Régression linéaire pour Python
===============================

mysklearn est un paquet complet pour implémenter
la régression linéaire en Python. 
"""

__version__ = '0.1.0'  <---

print(mysklearn.__version__)

0.1.0

bumpversion

Outil pratique pour mettre à jour tous les numéros de version du paquet

bumpversion major

bumpversion minor

bumpversion patch

mysklearn/    <--   se rendre ici
|-- mysklearn/
|   |-- __init__.py
|   `-- mysklearn.py
|-- setup.py
...

Passons à la pratique !

Créer des paquetages Python