A technical debt tracker package
Project description
Tech-debt
A simple tool to quantify your technical debt
Installation
pip install techdebt
Usage
- Adding debpt annotation
add debt annotations in your project files to mark technical debt:
- @debt()
- @debt("debt_type") or
- @debt("debt_type":"comment")
Let's say you have a python file with some debt :
#@debt("implementation")
def poor_function():
#@debt("implementation": "variable naming")
bla = 2
return bla
- Project configuration
Adapt the following configuration file and put it in your project folder (cf config_example.yml)
folder:
included:
- test_project/subA
- test_project/subB
excluded:
- vendor
- node_modules
- var
- web
- nbproject
- public
- .git
- __pycache__
extensions:
- .py
- .js
- .md
- .php
scores:
api: 5
implementation: 3
- Run
python main.py --conf="path/to/config_file.yml" #default is "techdebt.yml"
Roadmap
- adding line file of annotation
- better reporting
- tracking debt over time
- adding estimation range
- Incorporating other tools in debt computing like static code analysis
Testing
pytest -s techdebt/lib.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
techdebt-0.1.tar.gz
(5.6 kB
view hashes)
Built Distribution
techdebt-0.1-py3-none-any.whl
(4.8 kB
view hashes)