Add 'notes' field to frames.

This is a large commit that adds the following:

1. Syntax: `watson stop --notes "some additional information"`.
2. Print only non-empty notes in log.
3. Always pass id to `new_frame` so that the length of array with/without
   notes doesn't cause ambiguity.
4. Print a warning message and the existing note if overwriting a note.
5. Print notes in report.

Co-authored-by: Tristan Pratt <[email protected]>
Co-authored-by: Rohitt Vashishtha <[email protected]>

Author: aero31aero

.travis.yml

@@ -6,6 +6,10 @@ matrix:
           os: linux
           dist: xenial
           env: TOXENV=flake8
+        - python: 2.7
+          os: linux
+          dist: trusty
+          env: TOXENV=py27
         - python: 3.5
           os: linux
           dist: trusty
@@ -18,14 +22,6 @@ matrix:
           os: linux
           dist: xenial
           env: TOXENV=py37
-        - python: 3.8
-          os: linux
-          dist: xenial
-          env: TOXENV=py38
-        - python: 3.9
-          os: linux
-          dist: xenial
-          env: TOXENV=py39
 
 install:
   - pip install tox

CHANGELOG.md

@@ -9,33 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- The `log` command output can now be filtered to exclude projects and tags via `--ignore-project` and `--ignore-tag` (#395)
-- Python 3.8 support (#402)
-- Python 3.9 support (#402)
-
-### Removed
-
-- Python 2.7 support (#305).
-
-## [1.10.0] - 2020-07-03
-
-### Added
-
 - Log output order can now be controlled via the `--reverse/--no-reverse` flag
   and the `reverse_log` configuration option (#369)
 - Add `--at` flag to the `start` and `restart` commands (#364).
-- Add `--color` and `--no-color` flags to force output to be colored or not
-  respectively (#350).
 
 ### Changed
 
 - Require latest Arrow version 0.15.6 to support ISO week dates (#380)
 
-### Fixed
-
-- Make after-edit-check ensure that edited time stamps are not in the future
-  (#381)
-
 ## [1.9.0] - 2020-05-27
 
 ### Added
@@ -260,8 +241,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 First stable public release 🎉
 
-[unreleased]: https://github.com/tailordev/watson/compare/1.10.0...HEAD
-[1.10.0]: https://github.com/tailordev/watson/compare/1.9.0...1.10.0
+[unreleased]: https://github.com/tailordev/watson/compare/1.9.0...HEAD
 [1.9.0]: https://github.com/tailordev/watson/compare/1.8.0...1.9.0
 [1.8.0]: https://github.com/tailordev/watson/compare/1.7.0...1.8.0
 [1.7.0]: https://github.com/tailordev/watson/compare/1.6.0...1.7.0

README.rst

@@ -24,18 +24,12 @@ On OS X, the easiest way to install **watson** is using `Homebrew <http://brew.s
 
   $ brew update && brew install watson
 
-On other platforms, install **watson** using pip or pip3, depending on which one is available:
+On other platforms, install **watson** using pip:
 
 .. code:: bash
 
   $ pip install td-watson
 
-or:
-
-.. code:: bash
-
-  $ pip3 install td-watson
-
 If you need more details about installing watson, please refer to the `documentation <https://tailordev.github.io/Watson>`_.
 
 Usage

docs/about/release-notes.md

@@ -5,25 +5,6 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.10.0] - 2020-07-03
-
-### Added
-
-- Log output order can now be controlled via the `--reverse/--no-reverse` flag
-  and the `reverse_log` configuration option (#369)
-- Add `--at` flag to the `start` and `restart` commands (#364).
-- Add `--color` and `--no-color` flags to force output to be colored or not
-  respectively (#350).
-
-### Changed
-
-- Require latest Arrow version 0.15.6 to support ISO week dates (#380)
-
-### Fixed
-
-- Make after-edit-check ensure that edited time stamps are not in the future
-  (#381)
-
 ## [1.9.0] - 2020-05-27
 
 ### Added
@@ -247,7 +228,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 First stable public release 🎉
 
-[1.10.0]: https://github.com/tailordev/watson/compare/1.9.0...1.10.0
 [1.9.0]: https://github.com/tailordev/watson/compare/1.8.0...1.9.0
 [1.8.0]: https://github.com/tailordev/watson/compare/1.7.0...1.8.0
 [1.7.0]: https://github.com/tailordev/watson/compare/1.6.0...1.7.0

docs/user-guide/commands.md

@@ -12,7 +12,7 @@
 Usage:  watson add [OPTIONS] [ARGS]...
 ```
 
-Add time to a project with tag(s) that was not tracked live.
+Add time for project with tag(s) that was not tracked live.
 
 Example:
 
@@ -24,8 +24,8 @@ Example:
 
 Flag | Help
 -----|-----
-`-f, --from DATETIME` | Date and time of start of tracked activity  [required]
-`-t, --to DATETIME` | Date and time of end of tracked activity  [required]
+`-f, --from DATE` | Date and time of start of tracked activity  [required]
+`-t, --to DATE` | Date and time of end of tracked activity  [required]
 `-c, --confirm-new-project` | Confirm addition of new project.
 `-b, --confirm-new-tag` | Confirm creation of new tag.
 `--help` | Show this message and exit.
@@ -53,7 +53,7 @@ If you are outputting to the terminal, you can selectively enable a pager
 through the `--pager` option.
 
 You can change the output format from *plain text* to *JSON* using the
-`--json` option or to *CSV* using the `--csv` option. Only one of these
+`--json` option or to *CSV* using the `--csv` option. Only one  of these
 two options can be used at once.
 
 
@@ -109,8 +109,8 @@ Example:
 Flag | Help
 -----|-----
 `-c, --current / -C, --no-current` | (Don't) include currently running frame in report.
-`-f, --from DATETIME` | The date from when the report should start. Defaults to seven days ago.
-`-t, --to DATETIME` | The date at which the report should stop (inclusive). Defaults to tomorrow.
+`-f, --from DATE` | The date from when the report should start. Defaults to seven days ago.
+`-t, --to DATE` | The date at which the report should stop (inclusive). Defaults to tomorrow.
 `-p, --project TEXT` | Reports activity only for the given project. You can add other projects by using this option several times.
 `-T, --tag TEXT` | Reports activity only for frames containing the given tag. You can add several tags by using this option multiple times
 `-j, --json` | Format output in JSON instead of plain text
@@ -141,8 +141,8 @@ Usage:  watson config [OPTIONS] SECTION.OPTION [VALUE]
 
 Get and set configuration options.
 
-If `value` is not provided, the content of the `key` is displayed. Else,
-the given `value` is set.
+If value is not provided, the content of the key is displayed. Else,
+the given value is set.
 
 You can edit the config file with an editor with the `--edit` option.
 
@@ -172,12 +172,12 @@ You can specify the frame to edit by its position or by its frame id.
 For example, to edit the second-to-last frame, pass `-2` as the frame
 index. 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).
+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 used is determined by the `VISUAL` or `EDITOR` environment
 variables (in that order) and defaults to `notepad` on Windows systems and
-to `vim`, `nano`, or `vi` (first one found) on all other systems.
+to `vim`, `nano` or `vi` (first one found) on all other systems.
 
 ### Options
 
@@ -237,22 +237,21 @@ can be controlled with the `--from` and `--to` arguments. The dates
 must have the format `YEAR-MONTH-DAY`, like: `2014-05-19`.
 
 You can also use special shortcut options for easier timespan control:
-`--day` sets the log timespan to the current day (beginning at `00:00h`)
-and `--year`, `--month` and `--week` to the current year, month, or week,
+`--day` sets the log timespan to the current day (beginning at 00:00h)
+and `--year`, `--month` and `--week` to the current year, month or week
 respectively.
 The shortcut `--luna` sets the timespan to the current moon cycle with
 the last full moon marking the start of the cycle.
 
 If you are outputting to the terminal, you can selectively enable a pager
 through the `--pager` option.
 
-You can limit the log to a project or a tag using the `--project`,
-`--tag`, `--ignore-project` and `--ignore-tag` options. They can be
-specified several times each to add or ignore multiple projects or
-tags in the log.
+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.
 
 You can change the output format from *plain text* to *JSON* using the
-`--json` option or to *CSV* using the `--csv` option. Only one of these
+`--json` option or to *CSV* using the `--csv` option. Only one  of these
 two options can be used at once.
 
 Example:
@@ -297,9 +296,8 @@ Example:
 Flag | Help
 -----|-----
 `-c, --current / -C, --no-current` | (Don't) include currently running frame in output.
-`-r, --reverse / -R, --no-reverse` | (Don't) reverse the order of the days in output.
-`-f, --from DATETIME` | The date from when the log should start. Defaults to seven days ago.
-`-t, --to DATETIME` | The date at which the log should stop (inclusive). Defaults to tomorrow.
+`-f, --from DATE` | The date from when the log should start. Defaults to seven days ago.
+`-t, --to DATE` | The date at which the log should stop (inclusive). Defaults to tomorrow.
 `-y, --year` | Reports activity for the current year.
 `-m, --month` | Reports activity for the current month.
 `-l, --luna` | Reports activity for the current moon cycle.
@@ -308,8 +306,6 @@ Flag | Help
 `-a, --all` | Reports all activities.
 `-p, --project TEXT` | Logs activity only for the given project. You can add other projects by using this option several times.
 `-T, --tag TEXT` | Logs activity only for frames containing the given tag. You can add several tags by using this option multiple times
-`--ignore-project TEXT` | Logs activity for all projects but the given ones. You can ignore several projects by using the option multiple times. Any given project will be ignored
-`--ignore-tag TEXT` | Logs activity for all tags but the given ones. You can ignore several tags by using the option multiple times. Any given tag will be ignored
 `-j, --json` | Format output in JSON instead of plain text
 `-s, --csv` | Format output in CSV instead of plain text
 `-g, --pager / -G, --no-pager` | (Don't) view output through a pager.
@@ -460,8 +456,8 @@ can be controlled with the `--from` and `--to` arguments. The dates
 must have the format `YEAR-MONTH-DAY`, like: `2014-05-19`.
 
 You can also use special shortcut options for easier timespan control:
-`--day` sets the report timespan to the current day (beginning at `00:00h`)
-and `--year`, `--month` and `--week` to the current year, month, or week,
+`--day` sets the report timespan to the current day (beginning at 00:00h)
+and `--year`, `--month` and `--week` to the current year, month or week
 respectively.
 The shortcut `--luna` sets the timespan to the current moon cycle with
 the last full moon marking the start of the cycle.
@@ -559,8 +555,8 @@ Example:
 Flag | Help
 -----|-----
 `-c, --current / -C, --no-current` | (Don't) include currently running frame in report.
-`-f, --from DATETIME` | The date from when the report should start. Defaults to seven days ago.
-`-t, --to DATETIME` | The date at which the report should stop (inclusive). Defaults to tomorrow.
+`-f, --from DATE` | The date from when the report should start. Defaults to seven days ago.
+`-t, --to DATE` | The date at which the report should stop (inclusive). Defaults to tomorrow.
 `-y, --year` | Reports activity for the current year.
 `-m, --month` | Reports activity for the current month.
 `-l, --luna` | Reports activity for the current moon cycle.
@@ -589,9 +585,9 @@ 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
+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,
+to a true value (`1`, `on`, `true` or `yes`), the current project, if any,
 will be stopped before the new frame is started. You can pass the option
 `-s` or `--stop` resp. `-S` or `--no-stop` to override the default or
 configured behaviour.
@@ -613,7 +609,6 @@ Example:
 
 Flag | Help
 -----|-----
-`--at DATETIME` | Start frame at this time. Must be in (YYYY-MM-DDT)?HH:MM(:SS)? format.
 `-s, --stop / -S, --no-stop` | (Don't) Stop an already running project.
 `--help` | Show this message and exit.
 
@@ -628,20 +623,10 @@ 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
+`options.stop_on_start` is set to a true value (`1`, `on`, `true` or
 `yes`), it is stopped before the new project is started.
 
-If `--at` option is given, the provided starting time is used. The
-specified time must be after the end of the previous frame and must not be
-in the future.
-
-Example:
-
-
-    $ watson start --at 13:37
-    Starting project apollo11 at 13:37
-    
-If the `--no-gap` flag is given, the start time of the new project is set
+If the '--no-gap' flag is given, the start time of the new project is set
 to the stop time of the most recently stopped project.
 
 Example:
@@ -654,7 +639,6 @@ Example:
 
 Flag | Help
 -----|-----
-`--at DATETIME` | Start frame at this time. Must be in (YYYY-MM-DDT)?HH:MM(:SS)? format.
 `-g, --gap / -G, --no-gap` | (Don't) leave gap between end time of previous project and start time of the current.
 `-c, --confirm-new-project` | Confirm addition of new project.
 `-b, --confirm-new-tag` | Confirm creation of new tag.
@@ -701,21 +685,27 @@ Usage:  watson stop [OPTIONS]
 
 Stop monitoring time for the current project.
 
-If `--at` option is given, the provided stopping time is used. The
-specified time must be after the beginning of the to-be-ended frame and must
+If '--at' option is given, the provided stopping time is used. The
+specified time must be after the begin of the to be ended frame and must
 not be in the future.
 
-Example:
+You can optionally pass a log message to be saved with the frame via
+the ``-n/--note`` option.
 
+Example:
 
     $ watson stop --at 13:37
     Stopping project apollo11, started an hour ago and stopped 30 minutes ago. (id: e9ccd52) # noqa: E501
+    $ watson stop -n "Done some thinking"
+    Stopping project apollo11, started a minute ago. (id: e7ccd52)
+    Log message: Done some thinking
 
 ### Options
 
 Flag | Help
 -----|-----
-`--at DATETIME` | Stop frame at this time. Must be in (YYYY-MM-DDT)?HH:MM(:SS)? format.
+`--at TIME` | Stop frame at this time. Must be in (YYYY-MM-DDT)?HH:MM(:SS)? format.
+`-n, --note TEXT` | Save given log message with the project frame.
 `--help` | Show this message and exit.
 
 ## `sync`

docs/user-guide/configuration.md

@@ -8,7 +8,7 @@ Watson configuration and data are stored inside your user's application folder.
 * **Windows**: `%appdata%\watson\config`, which usually expands to `C:\Users\<user>\AppData\Roaming\watson\config`
 * **Linux**: `~/.config/watson/config`
 
-The configuration file is a typical [python configuration (INI) file](https://docs.python.org/3.9/library/configparser.html#supported-ini-file-structure), that looks like:
+The configuration file is a typical [python configuration (INI) file](https://docs.python.org/3.7/library/configparser.html#supported-ini-file-structure), that looks like:
 
 ```ini
 [Simple Values]
@@ -55,7 +55,7 @@ empty string value here =
         # Did I mention we can indent comments, too?
 ```
 
-_This example configuration file has been taken from the [official python documentation](https://docs.python.org/3.9/library/configparser.html#supported-ini-file-structure)._
+_This example configuration file has been taken from the [official python documentation](https://docs.python.org/3.7/library/configparser.html#supported-ini-file-structure)._
 
 
 ## Editing

scripts/fuzzer.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 
 import arrow
 import random

scripts/gen-cli-docs.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 
 import inspect