Skip to main content

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/taggregator.py  :57   # @BUG(HIGH) Throws OSError on some files if in use
taggregator/taggregator/taggregator.py  :64   # @SPEED(MEDIUM) Regex search of processed line
taggregator/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 ~/.taggregator/config.json but the program will prioritise a config file stored in {current_directory}/.taggregator/config.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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

taggregator-0.0.40.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

taggregator-0.0.40-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file taggregator-0.0.40.tar.gz.

File metadata

  • Download URL: taggregator-0.0.40.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.9.1 setuptools/36.6.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for taggregator-0.0.40.tar.gz
Algorithm Hash digest
SHA256 a57958976b2d36bac064d522364db3d736dba751c98987021d9437862fb73755
MD5 a1c8c4f4b21108d8ba8bc978981fb955
BLAKE2b-256 bf16eaf4fbbf910fea427e58dd2ce96612913cbb8f9e0a877a0a7f75c01cb53e

See more details on using hashes here.

File details

Details for the file taggregator-0.0.40-py3-none-any.whl.

File metadata

  • Download URL: taggregator-0.0.40-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.9.1 setuptools/36.6.0 requests-toolbelt/0.8.0 tqdm/4.23.4 CPython/2.7.15

File hashes

Hashes for taggregator-0.0.40-py3-none-any.whl
Algorithm Hash digest
SHA256 bfe83200fce99e758d74ad2a0b8344a8ec30a56f9f371e8e0b7c8c60d5059da0
MD5 7c8d681c2e04dbd162eff0bdadf4716d
BLAKE2b-256 7ddf1c909c159b3dfd510795ce45e76049bcf7891858a1045832aed9c0d1944e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page