Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/k4j8/watson-graphing

Create graphs from Watson time-tracking data
https://github.com/k4j8/watson-graphing

Last synced: about 14 hours ago
JSON representation

Create graphs from Watson time-tracking data

Awesome Lists containing this project

README

        

# watson-graphing

watson-graphing is a command-line program that generates graphs from [Watson](https://tailordev.github.io/Watson/), a command-line manual time-tracking tool.

## Basic Example

To plot data from the past week using defaults, just run the program with no options:
```
$ watson-graphing
```
![watson_graphing_basic](example-images/watson_graphing_basic.png)

## Detailed Example

To plot Watson data for the specified plots (hours, attributes, and location), with the totals bar chart, by month, sorting alphabetically, truncating project names before the first period, showing the date range in the title of each chart, using data from the past year, and excluding the projects `break` and `pto`, run:
```
$ watson-graphing --plot hours attributes location --totals --period month --sort name --truncate --date year ignore-project break ignore-project pto
```
![watson_graphing_full_1](example-images/watson_graphing_full_1.png)
![watson_graphing_full_2](example-images/watson_graphing_full_2.png)

## Getting Started

### Installation

This project is not published on PyPI (pip) yet. If you would like it to be, please open an issue.

To install, clone/download the repository and then install.
```
$ git clone https://github.com/k4j8/watson-graphing.git
$ pip install --editable watson-graphing
```

To update, just run `git pull`.

### Usage

Watson must also be installed and have at least one frame to show for watson-graphing to work. Commands take the form `watson-graphing [options] WATSON_ARGS...`.

- `[options]` are available via `watson-graphing --help`
- `WATSON_ARGS` are inputs to the cammand `watson log...` WITHOUT hyphens. (Weird, I know, but it works.)

For example, to plot the result of `watson log --project voyager2 --project apollo11`, run `watson-graphing project voyager2 project apollo11`.

Keep in mind `watson log` defaults to the past 7 days, so to get more data you need to include `year`, `all`, or any other option available via `watson log`.

watson-graphing splits Watson's tags into two categories: attributes and locations. Locations are tags beginning with `@` such as `@office` or `@home`. Attributes are all other tags.

## Contributing

This is a personal project, but I'm willing to make it more universal if there's an interest. Please use the issue tracker if you have suggestions, feedback, or want to contribute.