Find lines of source code you have tagged with custom categories
Project description
taggregator
Find lines of source code you have tagged with custom categories, defined inside a config.json
file.
For example, to tag a piece of code which contains a bug, write a comment as below:
do_stuff()
# @BUG(HIGH) buggy_code() throws an unhandled exception!
buggy_code()
do_more_stuff()
You can then run tagg
in the project root directory and it will output the file name, line number and description to the console as below.
taggregator/taggregator.py :57 # @BUG(HIGH) Throws OSError on some files if in use
taggregator/taggregator.py :64 # @SPEED(MEDIUM) Regex search of processed line
taggregator/__main__.py :34 # @TODO(LOW) Allow user to specify path for config file
Each line marked with a tag will be ordered and coloured by priority. By default, there are a number of tags and priorities in the config file installed.
Installation
$ pip3 install --upgrade taggregator
Installation will also create a config file at ~/.tagg.json
but the program will prioritise a config file stored in {current_directory}/.tagg.json
if it exists.
Run
From project root
$ tagg
From a specified folder
$ tagg Assets/Scripts
Only return lines marked with "speed" and "refactor"
$ tagg -t "speed, refactor"
Create config file in current directory
$ tagg create .
Workflow integration
It might be useful to bind taggregator to a key combination in a tool like vim. For example, place this in your ~/.vimrc:
nnoremap <leader>t :!clear;tagg<CR>
Presuming your vim leader is ',' you can then access your taggregator todo list at any time by typing ',t' while editing.
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
File details
Details for the file taggregator-0.0.48.tar.gz
.
File metadata
- Download URL: taggregator-0.0.48.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
241eb8951e6532872ed2cb33509ff06aa5c9a916a46e94df6b5bbce478661fdc
|
|
MD5 |
3f6fa7774fbaf41b5f4d2876936cdb45
|
|
BLAKE2b-256 |
80a3fd760460a6c148d3b1a3b4b8d00c178fce720530ec3cc6c9e902cde94af2
|