Commit 4adbb39f authored by Erik Bjäreholt's avatar Erik Bjäreholt
Browse files

updated changelog, watchers, installing-from-source

parent 360124d2
......@@ -2,11 +2,34 @@
Changelog
=========
.. warning::
We haven't gotten to the point where we keep a flawless changelog yet. Please refer to the git history for more detail and certainty.
v0.8.0b1
--------
Released
========
Server:
- New query2 API for querying and transforming data
- Added :code:`version` field to :code:`/info` endpoint
- Set stricter allowed CORS origins in testing mode
- Added :code:`--cors-origins` CLI argument
Web UI:
- Added datepicker to the activity view
- Moved the today/clock visualization into the activity view
- New visualization for most-visited domains
- New visualization for previous days active time
- New query explorer
- Now displays version and hostname in bottom-right corner
- Now uses aw-client-js for all API calls
Watchers:
- Improved stability of client event queues (`see this PR <https://github.com/ActivityWatch/aw-client/pull/28>`_)
Other:
- Windows: Console window and taskbar icon now hidden by default (`issue #139 <https://github.com/ActivityWatch/activitywatch/issues/139>`_)
- All issues assigned to the v0.8 milestone can be found `on GitHub <https://github.com/ActivityWatch/activitywatch/milestone/1>`_
v0.7.1
--------
......@@ -18,7 +41,7 @@ v0.7.0b4
--------
- The ActivityWatch WebExtension is now supported from this version forward, see the announcement `on the forum <https://forum.activitywatch.net/t/you-can-now-track-your-web-browsing-with-activitywatch/28>`_.
- (Not really, see v0.7.0b5) Fixed pesky timezone issue in web UI (`issue #117 <https://github.com/ActivityWatch/activitywatch/issues/117>`_).
- (Not really, see v0.7.1) Fixed pesky timezone issue in web UI (`issue #117 <https://github.com/ActivityWatch/activitywatch/issues/117>`_).
- Fixed bug on macOS where keyboard activity would not be used to detect AFK state.
- Fixed packaging bugs (macOS, PyInstaller).
- The web extension now has a better look and notifies if connection to server failed.
......@@ -61,7 +84,7 @@ Upcoming
.. warning::
**Unreleased**: These are planned changelogs and will therefore change when plans change.
v0.7.2 (planned)
v0.9.1? (planned)
----------------
- New query2 API for querying and transforming data
......
......@@ -36,10 +36,12 @@ You need to ensure you have:
Using a virtualenv
------------------
It is recommended to use a virtualenv in order to avoid polluting your system with ActivityWatch-specific packages Python packages. It also makes it easier to uninstall since all you have to do is remove the virtualenv folder.
.. note::
If you don't want to use a virtualenv you could instead set the environment variable :code:`PIP_USER=true` when building. This will install ActivityWatch for your user only instead of trying to install it system-wide (which would fail since it requires root). If you do this, make sure that the folder :code:`~/.local/bin` (on Linux) or :code:`~/Library/Python/<version>/bin` (on macOS) is in your PATH so that you can run the programs once installed.
If you don't want to use a virtualenv you could instead set the environment variable :code:`PIP_USER=true` when building in the next step.
But make sure that the folder :code:`~/.local/bin` (on Linux) or :code:`~/Library/Python/<version>/bin` (on macOS) is in your PATH.
It is recommended to use a virtualenv in order to avoid polluting your system with ActivityWatch-specific Python packages.
It also makes it easier to uninstall since all you have to do is remove the virtualenv folder.
.. code-block:: sh
......@@ -65,7 +67,8 @@ Build and install everything into the virtualenv:
make build
.. note::
If you are going to develop we suggest building/installing using :code:`make build DEV=true` which installs all Python packages with pip's handy :code:`--editable` flag. By doing this you wont have to reinstall everything whenever you want to try out a code change.
If you're building from source to develop we suggest building/installing using :code:`make build DEV=true` which installs all Python packages with pip's handy :code:`--editable` flag.
By doing this you wont have to reinstall everything whenever you want to try out a code change.
Running
-------
......
......@@ -13,15 +13,21 @@ ActivityWatch comes bundled with two watchers by default:
- `aw-watcher-afk <https://github.com/ActivityWatch/aw-watcher-afk>`_ - Watches for mouse & keyboard activity to detect if the user is active.
- `aw-watcher-window <https://github.com/ActivityWatch/aw-watcher-window>`_ - Watches the active window and its title.
Others
Extras
------
The default watchers are collecting some of the most important data.
But there is more to collect, so here are some other watchers that let you do so.
- `aw-watcher-web <https://github.com/ActivityWatch/aw-watcher-web>`_ - (Beta) A browser extension that watches the active tab and its title along with its URL.
- `aw-watcher-web <https://github.com/ActivityWatch/aw-watcher-web>`_ - A browser extension that watches the active tab and its title along with its URL.
- `aw-watcher-vscode <https://github.com/ActivityWatch/aw-watcher-vscode>`_ - Watches editor activity in Visual Studio Code.
In development
--------------
- `aw-watcher-vim <https://github.com/ActivityWatch/aw-watcher-vim>`_ - (Beta) Watches editor activity in vim.
- `aw-watcher-spotify <https://github.com/ActivityWatch/aw-watcher-spotify>`_ - (Beta) Uses the Spotify Web API to get the active track.
- `aw-watcher-chromecast <https://github.com/ActivityWatch/aw-watcher-chromecast>`_ - (WIP) Watches whatever your Chromecast is up to.
Have you written one yourself? Send us an email or PR to have it included!
Have you written one yourself? Send us a PR to have it included!
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment