witch-ver

Have you ever asked yourself which version you're at? witch-ver can help.

witch-ver automatically calculates the version of a git repo and adds the information when building.

If you just want to integrate witch-ver into your project, head to usage

Environment

List of dependencies for package to run.

Required

• git
• python modules, installed via pip install witch-ver
  • colorama
  • setuptools

Optional

• Test extensions, installed via pip install witch-ver[test]
  • AutoDict
  • coverage
  • time-machine
  • tomli

Installation / Build / Deployment

# To install latest stable version on PyPi, execute:
python -m pip install witch-ver

# To install from source, execute:
git clone https://github.com/WattsUp/witch-ver
cd witch-ver
python -m pip install .

# For development, install as a link to repository such that code changes are used. And include testing packages
git clone https://github.com/WattsUp/witch-ver
cd witch-ver
python -m pip install -e ".[dev]"

Usage

To use witch-ver in your project, add two lines to the project configuration. Also should have some git tags.

# setup.py
setuptools.setup(
    ...
    use_witch_ver=True,
    ...
)

# pyproject.toml
[build-system]
requires = [
    ...
    "witch-ver",
    ...
]

Running Tests

Make sure to install package with testing extension Unit tests

> python -m test

Coverage report

> python -m coverage run && python -m coverage report

Development

Code development of this project adheres to Google Python Guide

Linters

> ruff .
> codespell .

Formatters

> isort .
> black .

Tools

• formatters.sh will run every formatter
• linters.sh will run every linter

Versioning

Versioning of this projects adheres to Semantic Versioning and is implemented using git tags.