Skip to content
Get updated task lists during development based on comments in your code.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
changelog
flowcat

README.md

flowcat 1.1.0

Get updated task lists during development based on comments in your code

PREREQUISITES

python >= 3.0 argopt python module

SETUP

To install flowcat run git clone https://github.com/Acetolyne/flowcat.git If you do not have argopt installed you can install it with pip3 install argopt You can now run flowcat from the directory you downloaded it to by running ./flowcat -f FOLDER/FILE OTHER OPTIONS To be able to run it from anywhere create a symbolic link in your /usr/bin or /usr/share/bin directory that points to the location of the flowcat executable.

ABOUT

Flowcat is a python program that parses the working directory or files of your development project and returns a list of tasks that need to be completed. This works by using a regex to parse comments in your code.

As an example if you leave a comment in your code #@todo Create function to sanitize variables flowcat lets you create a list of all the comments you have left in your files about what needs to be done and will return a list of each comment starting with #@todo.Flowcat will parse recursively through a directory you specify or let you specify a single file.

While #@todo is the default, it can be replaced by any regular expression by specifying it as the -m argument.

Works great in team development environments as well! No need to track your outstanding tasks in different software or seperate files. With flowcat note the task that needs to be done while you are writing the code.

If multiple people are working on a file simply note the name of the person in the comment to assign the task to them and let them use flowcat to match the tasks that belong to them.

As an example:

#@marvin Fix the sanitation of variables
SOME CODE
#@Arthur Create a new menu item for the babel fish on our site.
#@marvin Create happy() function to define things that make you happy.

Now when we run taskcat we can specify the regex in the argument as -m "#@marvin" to get all of Mavin's tasks and -m "#@Arthur" to get a list of Arthur's tasks. All tasks should be a comment in your code in PHP your line should start with \\ in python and other laguages it will need to start with a #

Note that flowcat will not recurse into hidden directories anymore, this caused a bug when parsing folders that had a .git directory. If you need to you can specify those directories in the -f argument to get the todo items from there but there should be no need to parse hidden directories. If there is a need please put in a feature request on GitHub.

OPTIONS

Usage: todolist [-h] (-f folder) [-o outfile] [-l] [-m match]

Options: -h --help Show this screen. -l Show line numbers -f /path/to/folder or file -o /path/to/outputfile File will be overwritten if it exists -m regex to match a todo item for example -m "#@note" matches anything after #@note. Defaults to "#@todo\ "

You can’t perform that action at this time.