Bump the version in the project files.
Project description
Bumplus is a command line tool to bump your project version.
Prerequisites
Python 3.8, 3.9, 3.10, 3.11, 3.12
Installation
pip install bumplus
Usage
Put a TOML file named .bumplus.toml in the top-level directory of your project. This file at least contains the following content:
version = "<current_version>"
See Configuration for more config options.
Command line
cd <project root dir>
bumplus <new_version>
Use bumplus –help to display the help text.
Python
import bumplus
bp = bumplus.Bumplus('<project root dir>')
bp.bump_version('<new_version>')
Example of .bumplus.toml
version = '1.2.3'
[[files."CHANGELOG.md"]]
search = '''
## Unreleased
'''
replace = '''
## Unreleased
## {{new_version}} - {{utcnow | strftime("%Y-%m-%d")}}
'''
[[files."CHANGELOG.md"]]
search = '''
http://host/changelog/{{old_version}}.html
'''
search = '''
http://host/changelog/{{new_version}}.html
http://host/changelog/{{old_version}}.html
'''
[[files."LICENSE"]]
search = '{{old_version}}'
replace = '{{new_version}}'
[[files."src/version.py"]]
search = '{{old_version}}'
replace = '{{new_version}}'
Configuration
version
A string that is the current version.
files
A table which configures all files need to be modified.
Every key is a relative path name. The value of a key is an array of replacement config. Every item of an array is an object which has two keys: search and replace. The value of search is the pattern to be replaced. The value of replace is the new text after replacing.
The contents of search and replace are Jinja2 templates. Several predefined variables can be used in the templates:
old_version
new_version
now
utcnow
now and utcnow are Python datetime objects.
The Jinja2 templates also support a custom filter strftime, which is used to format time such as now and utcnow. The format string is the same as the parameter of strftime method of Python datetime object.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.