Metadata-Version: 2.1
Name: bumpr
Version: 0.3.8
Summary: Version bumper and Python package releaser
Home-page: https://github.com/noirbizarre/bumpr
License: LGPL
Keywords: version,bump,release,tag
Author: Axel H.
Author-email: noirbizarre@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Provides-Extra: doc
Provides-Extra: lint
Provides-Extra: test
Requires-Dist: mkdocs (>=1.2.3,<2.0.0); extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=3.2.3,<4.0.0); extra == "doc"
Requires-Dist: mkdocs-material (>=7.3.5,<8.0.0); extra == "doc"
Requires-Dist: mkdocstrings (>=0.16.2,<0.17.0); extra == "doc"
Project-URL: Bug Tracker, https://github.com/noirbizarre/bumpr/issues
Project-URL: Documentation, https://bumpr.readthedocs.io/en/stable/
Project-URL: Repository, https://github.com/noirbizarre/bumpr
Description-Content-Type: text/markdown

# Bump'R: Bump and release versions

[![Build Status](https://github.com/noirbizarre/bumpr/actions/workflows/main.yml/badge.svg?tag=0.3.8)](https://github.com/noirbizarre/bumpr/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/noirbizarre/bumpr/branch/master/graph/badge.svg?token=G8u0QBT1Sj)](https://codecov.io/gh/noirbizarre/bumpr)
[![Documentation Status](https://readthedocs.org/projects/bumpr/badge/?version=0.3.8)](https://bumpr.readthedocs.io/en/0.3.8/?badge=latest)
![PyPI - Last version](https://img.shields.io/pypi/v/bumpr)
![PyPI - License](https://img.shields.io/pypi/l/bumpr)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/bumpr)

Bump'R is a version bumper and releaser allowing in a single command:

- Clean-up release artifact
- Bump version and tag it
- Build a source distribution and upload on PyPI
- Update version for a new development cycle

Bump'R intend to be customizable with the following features:

- Optionnal test suite run before bump
- Customizable with a config file
- Overridable by command line
- Extensible with hooks

## Compatibility

Bump'R requires Python `>=3.7` (and `<4.0`)

## Installation

You can install Bump'R with pip:

```console
pip install bumpr
```

## Usage

You can use directly the command line to setup every parameter:

```console
bumpr fake/__init__.py README.rst -M -ps dev
```

But Bump'R is designed to work with a configuration file (`bumpr.rc` by defaults).
Some features are only availables with the configuration file like:

- commit message customization
- hooks configuration
- multiline test, clean and publish commands

Here's an exemple:

```ini
[bumpr]
file = fake/__init__.py
vcs = git
tests = tox
publish = python setup.py sdist register upload
clean =
    python setup.py clean
    rm -rf *egg-info build dist
files = README.rst

[bump]
unsuffix = true
message = Bump version {version}

[prepare]
suffix = dev
message = Prepare version {version} for next development cycle

[changelog]
file = CHANGELOG.rst
bump = {version} ({date:%Y-%m-%d})
prepare = In development

[readthedoc]
id = fake
```

This way you only have to specify which part you want to bump on the
command line:

```console
bumpr -M  # Bump the major
bumpr     # Bump the default part aka. patch
```

## Documentation

The documentation is hosted on Read the Docs:

- [Stable](https://bumpr.readthedocs.io/en/stable/) [![Stable documentation status](https://readthedocs.org/projects/bumpr/badge/?version=stable)](https://bumpr.readthedocs.io/en/stable/?badge=stable)
- [Development](https://bumpr.readthedocs.io/en/0.3.8/) [![Latest documentation Status](https://readthedocs.org/projects/bumpr/badge/?version=0.3.8)](https://bumpr.readthedocs.io/en/0.3.8/?badge=latest)

