Permalink
Fetching contributors…
Cannot retrieve contributors at this time
63 lines (43 sloc) 1.15 KB

API Reference

Here's an API reference for some of the most central components in aw_core, aw_client and aw_server. These are the most important packages in ActivityWatch. A lot of it currently lacks proper docstrings, but it's a start.

aw_core

.. automodule:: aw_core
   :members:
   :undoc-members:

aw_core.models

.. automodule:: aw_core.models
   :members: Event
   :undoc-members:

aw_core.log

.. automodule:: aw_core.log
   :members:
   :undoc-members:

aw_core.dirs

.. automodule:: aw_core.dirs
   :members:
   :undoc-members:


aw_client

The aw_client package contains a programmer-friendly wrapper around the servers REST API.

.. automodule:: aw_client
   :members: ActivityWatchClient
   :undoc-members:


aw_server

.. automodule:: aw_server
   :members:
   :undoc-members:

aw_server.api

The ServerAPI class contains the basic API methods, these methods are primarily called from RPC layers such as the one found in aw_server.rest.

.. automodule:: aw_server.api
   :members: ServerAPI
   :undoc-members: