Metadata-Version: 2.4
Name: update-version
Version: 0.2.1
Summary: Updates your project's version from a versioning file
Author-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
Maintainer-email: Guennadi Maximov C <g.maxc.fox@protonmail.com>
License-Expression: GPL-2.0-only
Project-URL: Download, https://github.com/DrKJeff16/update-version/releases/latest
Project-URL: Funding, https://github.com/sponsors/DrKJeff16
Project-URL: Issues, https://github.com/DrKJeff16/update-version/issues
Project-URL: Repository, https://github.com/DrKJeff16/update-version
Keywords: versioning,updater,preprocessing,text
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python
Classifier: Topic :: Text Processing :: Filters
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argparse
Dynamic: license-file

# update-version

A minimalist Python script to update your project's version through a `version.txt` file.

---

## Installation

You can install it through `pip`:

```sh
pip install update-version
```

This script will install the following python packages as dependencies:

- `argparse`
- `argcomplete`

---

## Usage

```
update-version [-h] [-v] [-V] [-P] [-L] [-D] [-e] [-p] [-m] [-M] [-d]
                    [-r <MAJOR>.<MINOR>.<PATCH>[-<EXTRA>]]
                    [path]
```

This script can be used for two types of versioning:

- `X.Y.Z`
- `X.Y.Z-N`

Where `X` is the major component, `Y` is the minor component and `Z` is the patch component.

If using `N` you will need to pass the `-d` option to the script.

<!-- vim: set ts=2 sts=2 sw=2 et ai si sta: -->
