A wonderful CLI to track your time!
Project description
Watson is here to help you monitoring your time. You want to know how much time you are spending on your projects? You want to generate a nice report for your client? Watson is here for you.
Tell Watson when you start working on a task with the start command. Then, when you are done with this task, stop the timer with the stop command. This will create what we call a frame. That’s pretty much everything you need to know to start using Watson.
Each frame consists of the name of a project and some tags. Your tags can be shared across projects and can be used to generate detailed reports.
Watson stores everything on your computer, but you can go wild and use artich.io to store your sessions remotely and share it with your colleagues.
Install
Watson is available on any platform supported by Python (Windows, Mac, Linux, *BSD…). The easiest way to install it is to use pip:
$ pip install td-watsonYou might need to run this command as root in order to install Watson globally.
Alternatively, you can choose to install Watson for your user only by running:
$ pip install --user td-watsonIf after this the watson command is not available, you need to add ~/.local/bin/ to your PATH. If your terminal is Bash, you can do this by running:
$ echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc # Add ~/.local/bin/ to your .bashrc PATHand restarting your terminal session or sourcing the .bashrc:
$ source ~/.bashrc # Reload your .bashrcDevelopment version
The latest development version can be installed using the following commands:
$ git clone https://github.com/TailorDev/Watson.git
$ cd Watson/
$ python setup.py installCommand line completion
If you use a Bash-compatible shell, you can install the watson.completion file from the source distribution as /etc/bash.completion.d/watson - or wherever your distribution keeps the Bash completion configuration files. After you restart your shell, you can then just type watson on your command line and then hit TAB to see all available commands. Depending on your input, it completes watson commands, command options, projects, tags and frame IDs.
Commands
Here is the listing of all the commands available with Watson. You can also find this help with watson help.
start
Start monitoring the time for the given project. You can add tags indicating more specifically what you are working on with ‘+tag’.
If there is already a running project and the configuration option options.stop_on_start is set to a true value ('1', 'on', 'true' or 'yes'), it is stopped before the new project is started.
Example : $ watson start apollo11 +module +brakes Starting apollo11 [module, brakes] at 16:34
stop
Stop monitoring time for the current project
$ watson stop Stopping project apollo11, started a minute ago. (id: e7ccd52)
restart
Restart monitoring time for a previously stopped project.
By default, the project from the last frame, which was recorded, is restarted, using the same tags as recorded in that frame. You can specify the frame to use with an integer frame index argument or a frame ID. For example, to restart the second-to-last frame, pass -2 as the frame index.
Normally, if a project is currently started, watson will print an error and do nothing. If you set the configuration option options.stop_on_restart to a true value ('1', 'on', 'true' or 'yes'), the current project, if any, will be stopped before the new farme is started. You can pass the option -s or --stop resp. -S or --no-stop to override the default or configured behaviour.
If no previous frame exists or and invalid frame index or ID was given, an error is printed and no further action taken.
Example:
$ watson start apollo11 +module +brakes Starting project apollo11 [module, brakes] at 16:34 $ watson stop Stopping project apollo11, started a minute ago. (id: e7ccd52) $ watson restart Starting project apollo11 [module, brakes] at 16:36
cancel
Cancel the last call to the start command. The time will not be recorded.
status
Display when the current project was started and the time spent since.
You can configure how the date and time of when the project was started are displayed by setting options.date_format and options.time_format in the configuration. The syntax of these formatting strings and the supported placeholders are the same as for the strftime method of Python’s datetime.datetime class.
$ watson status Project apollo11 [brakes] started seconds ago (2014-05-19 14:32:41+0100) $ watson config options.date_format %d.%m.%Y $ watson config options.time_format "at %I:%M %p" $ watson status Project apollo11 [brakes] started a minute ago (19.05.2014 at 02:32 PM)
report
Display a report of the time spent on each project.
If a project is given, the time spent on this project is printed. Else, print the total for each root project.
By default, the time spent the last 7 days is printed. This timespan can be controlled with the --from and --to arguments. The dates must have the format YEAR-MONTH-DAY, like: 2014-05-19.
You can limit the report to a project or a tag using the --project and --tag options. They can be specified several times each to add multiple projects or tags to the report.
$ watson report
Mon 05 May 2014 -> Mon 12 May 2014
apollo11 - 13h 22m 20s
[brakes 7h 53m 18s]
[module 7h 41m 41s]
[reactor 8h 35m 50s]
[steering 10h 33m 37s]
[wheels 10h 11m 35s]
hubble - 8h 54m 46s
[camera 8h 38m 17s]
[lens 5h 56m 22s]
[transmission 6h 27m 07s]
voyager1 - 11h 45m 13s
[antenna 5h 53m 57s]
[generators 9h 04m 58s]
[probe 10h 14m 29s]
[sensors 10h 30m 26s]
voyager2 - 16h 16m 09s
[antenna 7h 05m 50s]
[generators 12h 20m 29s]
[probe 12h 20m 29s]
[sensors 11h 23m 17s]
Total: 43h 42m 20s
$ watson report --from 2014-04-01 --to 2014-04-30 --project apollo11
Tue 01 April 2014 -> Wed 30 April 2014
apollo11 - 13h 22m 20s
[brakes 7h 53m 18s]
[module 7h 41m 41s]
[reactor 8h 35m 50s]
[steering 10h 33m 37s]
[wheels 10h 11m 35s]
log
Display each recorded frames during the given timespan.
By default, the frames from the last 7 days are printed. This timespan can be controlled with the --from and --to arguments. The dates must have the format YEAR-MONTH-DAY, like: 2014-05-19.
You can limit the log to a project or a tag using the --project and --tag options. They can be specified several times each to add multiple projects or tags to the log.
$ watson log
Thursday 08 May 2015 (56m 33s)
f35bb24 09:26 to 10:22 56m 33s apollo11 [reactor, brakes, steering, wheels, module]
Wednesday 07 May 2015 (27m 29s)
9a1325d 09:48 to 10:15 27m 29s voyager2 [sensors, generators, probe]
Tuesday 06 May 2015 (1h 47m 22s)
530768b 12:40 to 14:16 1h 35m 45s apollo11 [wheels]
84164f0 14:23 to 14:35 11m 37s apollo11 [brakes, steering]
Monday 05 May 2015 (8h 18m 26s)
26a2817 09:05 to 10:03 57m 12s voyager2 [probe, generators]
5590aca 10:51 to 14:47 3h 55m 40s apollo11
c32c74e 15:12 to 18:38 3h 25m 34s voyager2 [probe, generators, sensors, antenna]
$ watson log --from 2014-04-16 --to 2014-04-17
Thursday 17 April 2014 (4h 19m 13s)
a96fcde 09:15 to 09:43 28m 11s hubble [lens, camera, transmission]
5e91316 10:19 to 12:59 2h 39m 15s hubble [camera, transmission]
761dd51 14:42 to 15:54 1h 11m 47s voyager1 [antenna]
Wednesday 16 April 2014 (5h 19m 18s)
02cb269 09:53 to 12:43 2h 50m 07s apollo11 [wheels]
1070ddb 13:48 to 16:17 2h 29m 11s voyager1 [antenna, sensors]
frames
Display the list of all frame IDs.
This is mainly useful for implementing Bash command line completion.
$ watson frames f1c4815 9d1a989 8801ec3 [...]
projects
Display the list of all existing projects.
$ watson projects apollo11 hubble voyager1 voyager2
edit
Edit a frame.
You can specify the frame to edit with an integer frame index or a frame id. For example, to edit the second-to-last frame, pass -2 as the frame index (put `` – `` in front of negative indexes to prevent them from being interpreted as an option). You can get the id of a frame with the watson log command.
If no id or index is given, the frame defaults to the current frame or the last recorded frame, if no project is currently running.
The $EDITOR environment variable is used to detect your editor.
remove
Remove a frame.
config
Get and set configuration options.
If value is not provided, the content of the key is displayed. Else, the given value is set.
You can edit the configuration file with an editor with the ‘–edit’ option.
$ watson config backend.token 7e329263e329 $ watson config backend.token 7e329263e329
sync
Get frames from the server and push the new ones.
Warning: this feature is still experimental and not yet publicly available.
In a near future, you will be able to sync Watson with your artich.io account or any compatible third-party back-end.
The URL of the server and the User Token must be defined in your configuration file or with the config command.
$ watson config backend.url http://localhost:4242 $ watson config backend.token 7e329263e329 $ watson sync Received 42 frames from the server Pushed 23 frames to the server
merge
Perform a merge of the existing frames with a conflicting frames file.
When storing the frames on a file hosting service, there is the possibility that the frame file goes out-of-sync due to one or more of the connected clients going offline. This can cause the frames to diverge.
If the –force command is specified, the merge operation will automatically be performed.
The only argument is a path to the the conflicting frames file.
Merge will output statistics about the merge operation.
Example:
$ watson merge frames-with-conflicts 120 frames will be left unchanged 12 frames will be merged 3 frame conflicts need to be resolved
To perform a merge operation, the user will be prompted to select the frame they would like to keep.
Example:
$ watson merge frames-with-conflicts --force
120 frames will be left unchanged
12 frames will be merged
3 frame conflicts need to be resolved
Will resolve conflicts:
frame 8804872:
< {
< "project": "tailordev",
< "start": "2015-07-28 09:33:33",
< "stop": "2015-07-28 10:39:36",
< "tags": [
< "intern",
< "daily-meeting"
< ]
< }
---
> {
> "project": "tailordev",
> "start": "2015-07-28 09:33:33",
> "stop": "**2015-07-28 11:39:36**",
> "tags": [
> "intern",
> "daily-meeting"
> ]
> }
Select the frame you want to keep: left or right? (L/r)
Configuration
The configuration and the data are stored inside your user’s application folder.
On Mac, this is ~/Library/Application Support/watson/config, on Windows this is C:\Users\<user>\AppData\Local\watson\config and on Linux ~/.config/watson/config.
If you want to edit your configuration, the best is to use the config command.
Deleting all your frames
If you want to remove all your frames, you can delete the frames file in your configuration folder (see above to find its location).
Contributor Code of Conduct
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/.
License
Watson is released under the MIT License. See the bundled LICENSE file for 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.
