Metadata-Version: 2.1
Name: verbump
Version: 0.2.1
Summary: Easy version incrementing CLI tool
Home-page: http://github.com/meyt/verbump
Author: MeyT
License: MIT
Description: # verbump
        
        Easy version incrementing CLI tool.
        
        * Automatic relative version bump
        * Automatic `git commit` and `git tag`
        * Regex based version pattern
        * Using `semver` style
        
        ## Installation
        
        ```bash
        pip install verbump
        ```
        
        ## Usage
        
        1. Create the configuration file `.verbump.ini` inside your project's root directory.
        2. Run `verbump`
        
        ```bash
        verbump [major|minor|patch|build]
        ```
        
        ### Relative bump
        
        ```bash
        verbump minor
        ```
        
        ## Configuration
        
        Available keys for `.verdump.ini` :
        
        * `pattern`: {string} Version pattern regex (required)
        * `commit`: {boolean} Enables git auto-commit
        * `tag`: {boolean} Enables git auto-tag
        * `commit_format`: {string} Auto-commit message format. default is `v%s`
        * `tag_format`: {string} Auto-tag name format. default is `v%s`
        
        ## Configuration samples
        
        ### Generic `VERSION` file:
        
        ```ini
        [file:VERSION]
        pattern = (\d+.\d+.\d+(?:.\d+)?)*
        ```
        
        ### Generic `VERSION` file, git auto-commit & auto-tag enabled:
        
        ```ini
        [file:VERSION]
        commit = true
        tag = true
        pattern = (\d+.\d+.\d+(?:.\d+)?)*
        ```
        
        ### Nodejs `package.json` :
        
        ```ini
        [file:package.json]
        pattern = "version"\s*:\s*"(\d+.\d+.\d+(?:.\d+)?)"\s*,
        ```
        
        ### Python `__version__` style:
        
        ```ini
        [file:mymodule/__init__.py]
        pattern = __version__\s*=\s*(?:"|')(\d+.\d+.\d+(?:.\d+)?)(?:"|')
        ```
        
Keywords: version versioning semver
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.5
Description-Content-Type: text/markdown
