Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdacasserole/dodgem
Version bumper for Python.
https://github.com/lambdacasserole/dodgem
cicd pip python semver utils versioning
Last synced: 12 days ago
JSON representation
Version bumper for Python.
- Host: GitHub
- URL: https://github.com/lambdacasserole/dodgem
- Owner: lambdacasserole
- License: mit
- Created: 2022-05-18T18:10:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-08T18:54:44.000Z (about 2 years ago)
- Last Synced: 2024-10-10T22:14:55.832Z (about 1 month ago)
- Topics: cicd, pip, python, semver, utils, versioning
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Table of Contents
## About The Project
![dodgem usage][product-screenshot]
Sometimes you need to bump the version in your Python project files automatically. For example, you might:
* Have a CI/CD pipeline, and want to automatically bump the patch version of your library on merge to your `develop` branch
* Have a workflow (e.g. on Bitbucket Pipelines, GitHub actions etc.) that allows developers to automatically perform version bumps by including tags in their commit message (e.g. `[major]`, `[minor]`)
* Just want to reduce the chances of human error when bumping version numbers manually
Dodgem is a command-line utility for doing all of the above, and a bit more, aiming to eventually cover as many Python project file formats as possible, but currently supporting:
* `setuptools` (`setup.py`) with the `version=` named argument
* `pyproject.toml` managed by the [Poetry](https://python-poetry.org/) dependency manager
Named after (version) [bumper cars](https://en.wikipedia.org/wiki/Bumper_cars) which are also sometimes called dodgems in some dialects of English.
### Built With
This project uses:
* [Click](https://click.palletsprojects.com/en/8.1.x/) for its CLI
* [Poetry](https://python-poetry.org/) for dependency management
* [Blessings](https://github.com/erikrose/blessings) for colorized and formatted CLI output
## Getting Started
Getting started is straightforward. Dodgem aims to automatically detect as much as possible.
### Prerequisites
You'll need Python 3.7 or newer with pip to install Dodgem.
### Installation
Install Dodgem using pip or your favourite Python dependency manager and you're done.
```bash
pip3 install dodgem
```
Test your installation with:
```bash
dodgem --help
```
You should see help documentation printed.
## Usage
You can use `dodgem --help` for detailed information on using the utility:
```
Usage: dodgem [OPTIONS]
Bump version numbers in a project file.
Options:
--file TEXT The file to parse (defaults to automatic
detection).
--file-type TEXT The file type to parse (defaults to automatic).
--file-format TEXT The file format to parse (defaults to automatic).
--commit-message TEXT The commit message to infer the version bump from.
--no-auto-patch If given, disables automatic patch version bump if
commit message provided.
--major-tag TEXT The commit message tag indicating a major version
bump.
--minor-tag TEXT The commit message tag indicating a minor version
bump.
--patch-tag TEXT The commit message tag indicating a patch version
bump.
--prerelease-tag TEXT The commit message tag indicating a prerelease
version bump.
--ignore-tag-case Ignores capitalization in commit message tags.
--quiet Suppresses all extraneous output.
--pep-440 Use PEP-440 for version strings.
--bump-major If given, performs a major version bump.
--bump-minor If given, performs a minor version bump.
--bump-patch If given, performs a patch version bump.
--bump-prerelease If given, performs a prerelease version bump.
--bump-build If given, performs a build version bump.
--prerelease-token TEXT The prerelease token to append.
--build-token TEXT The build token to append.
--dry If given, does not write the version change to
disk.
--help Show this message and exit.
```
### Example: Bump Minor Version
Bump the minor version of your project like this:
```bash
dodgem --bump-minor
```
If you don't want to commit the change to disk, use `--dry` like so:
```bash
dodgem --bump-minor --dry
```
If the informational output given by the CLI is getting in the way of downstream processing, use `--quiet`:
```bash
dodgem --bump-minor --quiet
```
### Example: From Commit Message
Dodgem can bump your project version based on a commit message. By default.
* If the message contains `[major]` then a major version bump will be performed
* If the message contains `[minor]` then a minor version bump will be performed
* Otherwise, a patch version bump will be performed
For example, to use your last `git` commit message to bump your projects version.
```bash
dodgem --commit-message="$(git log -1)"
```
### Example: Custom Tags
If the default `[major]` and `[minor]` tags don't suit you, and you'd perfer `(major)`, `(minor)` and an _explicit_ `(patch)` tag:
```bash
dodgem --commit-message="$(git log -1)" --major-tag='(major)' --minor-tag='(minor)' --patch-tag='(patch)' --no-auto-patch
```
## Roadmap
- [x] Support `setuptools` (`setup.py`)
- [x] Support [Poetry](https://python-poetry.org/)
- [x] Support prerelease/build versions (shoutout to [@mitchelkoster](https://github.com/mitchelkoster) for the feature idea)
See the [open issues](https://github.com/lambdacasserole/dodgem/issues) for a full list of proposed features (and known issues).
## Contributing
Any contributions are very welcome. Please fork the project and open a PR, or open an issue if you've found a bug and/or would like to suggest a feature.
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Saul Johnson - [@lambdacasserole](https://twitter.com/lambdacasserole) - [email protected]
Project Link: [https://github.com/lambdacasserole/dodgem](https://github.com/lambdacasserole/dodgem)
## Acknowledgments
The following resources are awesome:
* [Best-README-Template](https://github.com/othneildrew/Best-README-Template) was used for this readme
* [tomlkit](https://github.com/sdispater/tomlkit/) was used for parsing TOML in a way that preserves comments, order, formatting etc.
* [semver](https://github.com/python-semver/python-semver) was used for parsing and bumping semver numbers
Shoutout to [@mitchelkoster](https://github.com/mitchelkoster) for contributing a load of feature ideas, and rooting out a bunch of bugs and edge cases!
[contributors-shield]: https://img.shields.io/github/contributors/lambdacasserole/dodgem.svg?style=for-the-badge
[contributors-url]: https://github.com/lambdacasserole/dodgem/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/lambdacasserole/dodgem.svg?style=for-the-badge
[forks-url]: https://github.com/lambdacasserole/dodgem/network/members
[stars-shield]: https://img.shields.io/github/stars/lambdacasserole/dodgem.svg?style=for-the-badge
[stars-url]: https://github.com/lambdacasserole/dodgem/stargazers
[issues-shield]: https://img.shields.io/github/issues/lambdacasserole/dodgem.svg?style=for-the-badge
[issues-url]: https://github.com/lambdacasserole/dodgem/issues
[license-shield]: https://img.shields.io/github/license/lambdacasserole/dodgem.svg?style=for-the-badge
[license-url]: https://github.com/lambdacasserole/dodgem/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/sauljohnson
[product-screenshot]: https://raw.githubusercontent.com/lambdacasserole/dodgem/main/usage.svg
