witch-ver 0.5.1

git tag based versioning

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.

---

Environment

List of dependencies for package to run.

Required

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

Optional

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

---

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 .[test]

---

Usage

Explain how to use your project.

# TODO

---

Running Tests

Make sure to install package with testing extension

# To run the automated tests, execute:
python -m tests discover -s tests -t . --locals

# To save the results to file, execute:
python -m tests discover -s tests -t . --locals &> testing.log

## The following is a synopsis of unittest main arguments ##
# To run a singular test file, execute:
python -m tests $path_to_test_file
python -m tests tests.test_main

# To run a singular test class, execute:
python -m tests $path_to_test_file.$class
python -m tests tests.test_main.TestMain

# To run a singular test method, execute:
python -m tests $path_to_test_file.$class.$method
python -m tests tests.test_main.TestMain.test_parser

# Multiple can be strung together
python -m tests tests.test_main tests.test_writer

# To run coverage and print the report with missing lines, execute:
python -m coverage run && python -m coverage report -m

# To run profiler, execute:
python -m cProfile -s tottime -m tests discover -s tests -t . > profile.log

# To run linting, execute:
python -m pylint witch_ver tests tools setup.py

---

Development

Code development of this project adheres to Google Python Guide

Styling

Use black to format files, easiest to use the format_all script

# To format all files, execute:
python tools/format_all.py

---

Versioning

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