Skip to content

Commit 0a896f1

Browse files
committed
docs(time): update with usage
1 parent 8649d05 commit 0a896f1

File tree

2 files changed

+41
-8
lines changed

2 files changed

+41
-8
lines changed

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ Built on top of [GAMADV-XTD3](https://github.com/taers232c/GAMADV-XTD3) and [GYB
1010

1111
```bash
1212
$ compiler-admin -h
13-
usage: compiler-admin [-h] [-v] {info,init,user} ...
13+
usage: compiler-admin [-h] [-v] {info,init,time,user} ...
1414

1515
positional arguments:
16-
{info,init,user} The command to run
17-
info Print configuration and debugging information.
18-
init Initialize a new admin project. This command should be run once before any others.
19-
user Work with users in the Compiler org.
16+
{info,init,time,user}
17+
The command to run
18+
info Print configuration and debugging information.
19+
init Initialize a new admin project. This command should be run once before any others.
20+
time Work with Compiler time entries.
21+
user Work with users in the Compiler org.
2022

2123
options:
22-
-h, --help show this help message and exit
23-
-v, --version show program's version number and exit
24+
-h, --help show this help message and exit
25+
-v, --version show program's version number and exit
2426
```
2527
2628
## Getting started
@@ -54,6 +56,37 @@ The `init` commands follows the steps in the [GAMADV-XTD3 Wiki](https://github.c
5456
5557
Additionally, GYB is used for Gmail backup/restore. See the [GYB Wiki](https://github.com/GAM-team/got-your-back/wiki) for more information.
5658
59+
## Working with time entires
60+
61+
The `time` command provides an interface for working with time entries from Compiler's various systems:
62+
63+
```bash
64+
$ compiler-admin time -h
65+
usage: compiler-admin time [-h] {convert} ...
66+
67+
positional arguments:
68+
{convert} The time command to run.
69+
convert Convert a time report from one format into another.
70+
71+
options:
72+
-h, --help show this help message and exit
73+
```
74+
75+
### Converting an hours report
76+
77+
With a CSV exported from either Harvest or Toggl, use this command to convert to the opposite format:
78+
79+
```bash
80+
$ compiler-admin time convert -h
81+
usage: compiler-admin time convert [-h] [--input INPUT] [--output OUTPUT] [--client CLIENT]
82+
83+
options:
84+
-h, --help show this help message and exit
85+
--input INPUT The path to the source data for conversion. Defaults to stdin.
86+
--output OUTPUT The path to the file where converted data should be written. Defaults to stdout.
87+
--client CLIENT The name of the client to use in converted data.
88+
```
89+
5790
## Working with users
5891

5992
The following commands are available to work with users in the Compiler domain:

compiler_admin/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def setup_init_command(cmd_parsers: _SubParsersAction):
4141

4242

4343
def setup_time_command(cmd_parsers: _SubParsersAction):
44-
time_cmd = add_sub_cmd(cmd_parsers, "time", help="Work with Compiler time entries")
44+
time_cmd = add_sub_cmd(cmd_parsers, "time", help="Work with Compiler time entries.")
4545
time_cmd.set_defaults(func=time)
4646
time_subcmds = add_sub_cmd_parser(time_cmd, help="The time command to run.")
4747

0 commit comments

Comments
 (0)