Skip to content

Commit 7908f8b

Browse files
committed
docs: rework README.md (remove old info and reflow to top up actionable steps) + add another example actogram
Signed-off-by: Stephen L. <LRQ3000@gmail.com>
1 parent f964822 commit 7908f8b

File tree

2 files changed

+28
-40
lines changed

2 files changed

+28
-40
lines changed

README.md

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,28 @@
33

44
🌐🏃Use your browser's history as a novel instantaneous mass screening tool for 🌙🛌sleep patterns & maybe disorders!
55

6+
<img src="actograms/example_actogram_horizontal_2024-01-20.png" alt="image" width="50%" height="auto" />
7+
8+
## Install & Quickstart
9+
10+
First you need a modern Python 3 interpreter, such as [Miniconda3](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links).
11+
12+
Then, install WebActogram with:
13+
14+
```pip install webactogram```
15+
16+
To generate an actogram and display it, type the following command in a terminal (or `cmd` or PowerShell on Windows):
17+
18+
```webactogram```
19+
20+
Note: First, you need to `cd` in a folder with write permission (so that the actogram image can be saved in a subfolder).
21+
22+
This will create a folder `actograms` in the current folder, and add inside a picture with the latest actogram and a csv file with all the browsers activities recorded.
23+
24+
More options, such as the sampling frequency (and hence granularity of the actogram and its patterns) can be shown with:
25+
26+
```webactogram --help```
27+
628
## Description
729
Python 3 tool to generate an online actogram from web browsers history files. Supports various browsers including Google Chrome, Mozilla Firefox and Safari history files (full list of supported browsers [here](https://browser-history.readthedocs.io/en/latest/browsers.html)).
830

@@ -28,52 +50,14 @@ The limitations are however as follows:
2850

2951
How the actogram is plotted was inspired by [this UCSD tutorial](https://ccb.ucsd.edu/the-bioclock-studio/education-resources/basics/part2.html) and [this scientific paper](https://doi.org/10.1186/1741-7007-8-93).
3052

31-
## Install & Quickstart
32-
33-
First you need a modern Python 3 interpreter, such as [Miniconda3](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links).
34-
35-
Then, install WebActogram with:
36-
37-
```pip install webactogram```
38-
39-
Use in a terminal (or `cmd` on Windows):
40-
41-
```webactogram```
42-
43-
Note: First, you need to `cd` in a folder with write permission.
44-
45-
This will create a folder `actograms` in the current folder, and add inside a picture with the latest actogram and a csv file with all the browsers activities recorded.
46-
47-
More options, such as the sampling frequency (and hence granularity of the actogram and its patterns) can be shown with:
48-
49-
```webactogram --help```
50-
51-
### Compatibility
52-
Currently configured to import history from ALL browsers available on the system, from the default user profiles for each:
53-
- Windows:
54-
- Chrome ``History`` file
55-
- Edge ``History`` file
56-
- Firefox ``History`` file
57-
- MacOS:
58-
- Chrome ``History`` file
59-
- Safari ``History.db``
60-
- Firefox ``History`` file
61-
- Linux:
62-
- Firefox ``History`` file
63-
64-
Currently, this script may not function as intended if you use multiple profiles within one browser (especially for Firefox), or the browser's default installation profile has changed.
65-
6653
## Usage
67-
History files are copied from their home directories to a temporary location in the working directory. These copies are then deleted after the script has executed. Only the ``last_visit_time`` is read.
68-
69-
Plots are easily generated from the command line:
54+
Plots are easily generated from the command line by typing the following command:
7055

7156
```webactogram```
7257

7358
Plots will be saved in a new sub-folder called "actograms" with appropriate timestamp and description.
7459

75-
76-
Script now supports command line arguments for additional customizability.
60+
The software now supports command line arguments for additional customizability.
7761
For example:
7862

7963
```python actogram.py --freq '15T' --daily_blur 3 --start '2020-01-01' ```
@@ -100,6 +84,10 @@ Where:
10084
--printer_friendly sets whether activity is shown in black on white (friendly) or vice versa (False by default, ex. --printer_friendly True)
10185
```
10286

87+
## Privacy statement
88+
89+
The only data that is extracted from your browsers usage is the datetime of visited pages from the browsers histories. The URLs is not extracted, nor any other information. No data is ever leaving your computer.
90+
10391
## Authors
10492

10593
This tool is a fork from the excellent [online_actogram](https://github.com/barrettfdavis/online_actogram) script by Barrett F. Davis who conceived both the idea and the first implementation initially released in [July 2020](https://web.archive.org/web/20221127100155/https://www.reddit.com/r/N24/comments/hxve2w/dont_delete_your_browser_history/).
245 KB
Loading

0 commit comments

Comments
 (0)