Skip to content

Commit 8b6bd00

Browse files
committed
docs(utility): add documentation for utility scripts
1 parent cb700ba commit 8b6bd00

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

docs/api-guide/utility.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Generate Placeholder Data
2+
3+
> [!INFO]
4+
> This script requires [Faker](https://github.com/hrishikeshio/Faker.py) to be installed. Install with `pip install faker`.
5+
6+
#### Entrypoint
7+
8+
```sh
9+
generate-fake-toggl-data
10+
```
11+
12+
### Arguments and Usage
13+
14+
#### Usage
15+
16+
```sh
17+
usage: generate-fake-toggl-data [-h] [-s SEED] [--cache-type {sqlite,json}] cache_path
18+
```
19+
20+
#### Arguments
21+
22+
| Short | Long | Default | Description |
23+
| ----- | -------------- | ------- | --------------------------------------------------------------------------------------- |
24+
| `-h` | `--help` | | Show this help message and exit. |
25+
| `-s` | `--seed` | `None` | Set the seed value. |
26+
| `-t` | `--cache-type` | `None` | Cache storage type.<br> Required if `cache_path` doesn't end with _.json_ or _.sqlite_. |
27+
28+
## Clean Toggl Account
29+
30+
> [!WARNING]
31+
> This will permanently delete data off a Toggl account! Be sure of what you are doing before using this script.
32+
33+
### Entrypoint
34+
35+
```sh
36+
clean-toggl-account
37+
```
38+
39+
### Arguments and Usage
40+
41+
#### Usage
42+
43+
```sh
44+
usage: clean-toggl-account [-h] [-o {tracker,project,tag,client,org} [{tracker,project,tag,client,org} ...]]
45+
```
46+
47+
#### Arguments
48+
49+
| Short | Long | Default | Description |
50+
| ----- | ----------- | ------- | -------------------------------- |
51+
| `-h` | `--help` | | Show this help message and exit. |
52+
| `-o` | `--objects` | `None` | Which objects not to parse. |

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ nav:
7575
- Client: api-guide/client.md
7676
- Tags: api-guide/tag.md
7777
- Reports: api-guide/reports.md
78+
- Utilities: api-guide/utility.md
7879
- Changelog: CHANGELOG.md
7980
- About:
8081
- Contributing: CONTRIBUTING.md

0 commit comments

Comments
 (0)