Metadata-Version: 2.1
Name: remla24-team8-lib-version
Version: 1.0.0
Summary: A version-aware library that can can be asked for the version of the library
Author: Tip ten Brink
Author-email: T.M.tenBrink@student.tudelft.nl
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: requests (>=2.32.3,<3.0.0)
Description-Content-Type: text/markdown

# lib-version

A version-aware library that can can be asked for the version of the library. This can be useful, for example, for verbose system information in log messages or data records. The library may also contain other logic.

• Create a VersionUtil class that can be asked for its version.
(Try to parse meta-data that is included in the package or explicitly store the version in a separate file.)

• The library is versioned automatically, e.g., by picking-up on the corresponding Git version tag.

• A workflow is used to automatically release the library in a package registry that matches the language.(As stated before, this includes either supported package registries on GitHub or repository tags in languages that support it.)

## Installation
The package is avaiable on pypi and can be installed directly using:

```shell
pip install remla24-team8-lib-version
```

## Usage

To get the current version include the following lines:

```python
from remla24_team8_lib_version import versioning

print(versioning.VersionUtil().version)
```
or from command-line

```bash
python3 -m remla24_team8_lib_version
```


