8757f2fd5e
Some checks failed
Build / Test on ubuntu-latest, py-3.8 (push) Successful in 4m21s
Lint / lint (push) Successful in 25s
Build / Test on macOS-latest, py-3.8 (push) Has been cancelled
Build / Test on windows-latest, py-3.8 (push) Has been cancelled
CodeQL / Analyze (python) (push) Failing after 1s
36 lines
1.5 KiB
Markdown
36 lines
1.5 KiB
Markdown
aw-core
|
|
=======
|
|
|
|
[](https://github.com/ActivityWatch/aw-core/actions)
|
|
[](https://codecov.io/gh/ActivityWatch/aw-core)
|
|
[](https://pypi.org/project/aw-core/)
|
|
[](https://github.com/psf/black)
|
|
[](http://mypy-lang.org/)
|
|
|
|
|
|
Core library for ActivityWatch.
|
|
|
|
|
|
## Modules
|
|
|
|
- `aw_core`, contains basic datatypes and utilities, such as the `Event` class, helpers for configuration and logging, as well as schemas for buckets, events, and exports.
|
|
- `aw_datastore`, contains the datastore classes used by aw-server-python.
|
|
- `aw_transform`, all event-transforms used in queries.
|
|
- `aw_query`, the query-language used by ActivityWatch.
|
|
|
|
## Logging
|
|
|
|
Run python with `LOG_LEVEL=debug` to use change the log level across all AW components
|
|
|
|
## How to install
|
|
|
|
To install the latest git version directly from github without cloning, run
|
|
`pip install git+https://github.com/ActivityWatch/aw-core.git`
|
|
|
|
To install from a cloned version, cd into the directory and run
|
|
`poetry install` to install inside an virtualenv. If you want to install it
|
|
system-wide it can be installed with `pip install .`, but that has the issue
|
|
that it might not get the exact version of the dependencies due to not reading
|
|
the poetry.lock file.
|
|
|