Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mardix/reversionup

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/mardix/reversionup
Owner: mardix
Created: 2014-12-25T10:20:13.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2018-07-08T05:02:58.000Z (over 6 years ago)
Last Synced: 2023-04-10T17:12:47.638Z (over 1 year ago)
Language: Python
Size: 17.6 KB
Stars: 6
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Reversionup

version: 0.5.x

---

ReversionUp, is a straight simple python module that helps you increment the version number
of your project. It can be used in the command line or accessed from your code.

ReversionUp follows strictly the 2.0.0 version of the [SemVer](http://semver.org/) scheme.

Version must be in the following scheme:

- major.minor.patch

- major.minor.patch-prerelease+build

---

### Install

pip install reversionup

## *reversionup* (cli)

Reversionup is best used in the command line to quickly increment version number.

reversionup

When launched for the first time `setup.cfg` will be created. It has a section
`reversionup` containing the current version.

# setup.cfg

[reversionup]
version = 0.0.1

Upon using the commands below, you'll be able to increment the major, minor and patch number of the file.

---

**reversionup or reversionup (-v|--version)**

Show the current version number

reversionup

> 0.0.1

---

**reversionup (-p|--patch)**

Increment the patch number

reversionup -p

> 0.0.2

---

**reversionup (-m|--minor)**

Increment the minor number and reset the patch

reversionup -m

> 0.1.0

---

**reversionup (-j|--major)**

Increment the major number and reset the minor and the patch number

reversionup -j

> 1.0.0

---

**reversionup (-d|--dry-run)**

Don't write the setup.cfg

reversionup
0.8.0

reversionup -d -p
0.8.1

reversionup
0.8.0

---

**reversionup (-e|--edit) [version]**

Edit your own version (semver compatible) version

reversionup -e 1.4.10

> 1.4.10

---

##Use as Module

As a module you can use the class `reversionup.Reversionup(version="0.0.0", file=None)` to access and increment the version.

## Examples

It is recommended to have a file `setup.cfg` with the option. This file will be used
to save the versioning data.

# setup.cfg

[reversionup]
version = 0.0.0

### Using the setup.cfg file and save the new version

from reversionup import Reversionup

filename = "setup.cfg"

rvnup = Reversionup(file=filename)

# read the version
version = rvnup.version

# increment major and reset minor and patch
rvnup.inc_major()

# increment minor and reset patch
rvnup.inc_minor()

# increment patch
rvnup.inc_patch()

# set the version manually
rvnup.version = "1.2.3"

# Save the file
rvnup.write()

### Manually load a version number and save to different file

from reversionup import Reversionup

rvnup = Reversionup("0.3.5")

# read the version
version = rvnup.version

---

## GIT Pre-Commit Hook

You can hook reversionup with git to update on each commit.

The script below will increase the patch number on commit. But you can find any other variant for it.

First (create if not exists) edit `.git/hooks/pre-commit` and add the code below.

#!/bin/sh
cd ./
reversionup -p
git add setup.cfg

Save it and type on the command line `chmod +x .git/hooks/pre-commit`

Now on each commit it will increase the patch number.

---