Skip to content

Commit 244e2e1

Browse files
authored
update invoke commands (#508)
* update invoke commands * fix
1 parent 9a28dc9 commit 244e2e1

6 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ pip3 install Invoke
2121
# setup installation
2222
invoke setup
2323
# generate secret key
24-
invoke create_secret_key
24+
invoke create-secret-key
2525
# setup local configuration (overrides GeoHealthCheck/config_main.py)
2626
vi instance/config_site.py
2727
# edit at least secret key:
28-
# - SECRET_KEY # copy/paste result string from `invoke create_secret_key`
28+
# - SECRET_KEY # copy/paste result string from `invoke create-secret-key`
2929

3030
# Optional: edit other settings or leave defaults
3131
# - SQLALCHEMY_DATABASE_URI

docker/scripts/run-runner.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ export PYTHONPATH=/GeoHealthCheck/GeoHealthCheck:$PYTHONPATH
1313

1414
cd /GeoHealthCheck
1515
source bin/activate
16-
invoke runner_daemon
16+
invoke runner-daemon
1717

1818
echo "END /run-runner.sh"

docker/scripts/run-tests.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ export PYTHONPATH=/GeoHealthCheck/GeoHealthCheck:$PYTHONPATH
1818

1919
cd /GeoHealthCheck
2020
source bin/activate
21-
invoke run_tests
21+
invoke run-tests
2222

2323
echo "END /run-tests.sh"

docs/admin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Or more compact within the root dir of your GHC installation: ::
9595

9696
Or even more compact within the root dir of your GHC installation via Invoke: ::
9797

98-
$ invoke create_hash -p mypass
98+
$ invoke create-hash -p mypass
9999
Copy/paste the entire token below for example to set password
100100
$pbkdf2-sha256$29000$FkJoTYnxPqc0pjQG4HxP6Q$C3SZb8jqtM7zKS1DSLcouc/CL9XMI9cL5xT6DRTOEd4
101101

docs/config.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The configuration options are:
1515

1616
- **SQLALCHEMY_DATABASE_URI**: the database configuration. See the SQLAlchemy documentation for more info
1717
- **SQLALCHEMY_ENGINE_OPTION_PRE_PING**: DB Disconnect Handling, emitting a test statement on the SQL connection at the start of each connection pool checkout (default: ``False``)
18-
- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``invoke create_secret_key`` to set this value
18+
- **SECRET_KEY**: secret key to set when enabling authentication. Use the output of ``invoke create-secret-key`` to set this value
1919
- **GHC_RETENTION_DAYS**: the number of days to keep Run history
2020
- **GHC_PROBE_HTTP_TIMEOUT_SECS**: stop waiting for the first byte of a Probe response after the given number of seconds
2121
- **GHC_MINIMAL_RUN_FREQUENCY_MINS**: minimal run frequency for Resource that can be set in web UI
@@ -51,7 +51,7 @@ The configuration options are:
5151
Example on overriding the configuration with an environment variable: ::
5252

5353
export GHC_SETTINGS=/tmp/my_GHC_settings.py
54-
invoke run_tests
54+
invoke run-tests
5555

5656
As an example: the `my_GHC_settings.py` file can contain a single line to define a test database: ::
5757

@@ -111,7 +111,7 @@ This is the preferred mode as each `Resource` can have its own schedule (configu
111111
via Dashboard) and `cron` has dependencies on local environment.
112112
Later versions may phase out cron-scheduling completely.
113113

114-
The **GHC Runner** can be run via the command `invoke runner_daemon` or can run internally within
114+
The **GHC Runner** can be run via the command `invoke runner-daemon` or can run internally within
115115
the **GHC Webapp** by setting the config variable **GHC_RUNNER_IN_WEBAPP** to `True` (the default).
116116
NB it is still possible to run GHC as in the pre-v0.5.0 mode using cron-jobs: just run the
117117
**GHC Webapp** with **GHC_RUNNER_IN_WEBAPP** set to `False` and have your cron-jobs scheduled.
@@ -153,7 +153,7 @@ Compiling Language Files
153153
........................
154154

155155
At runtime compiled versions, `.mo` files, of the language-files are used.
156-
Easiest to compile is via: `invoke compile_translations` in the project root dir.
156+
Easiest to compile is via: `invoke compile-translations` in the project root dir.
157157
This basically calls `pybabel compile` with the proper options.
158158
Now you can e.g. test your new translations by starting GHC.
159159

@@ -175,7 +175,7 @@ Missing translations will have `msgstr ""` like in this excerpt: ::
175175

176176
Next all empty `msgstr` can be filled.
177177

178-
Updating is easiest using the command `invoke update_translations` within the root dir of the project.
178+
Updating is easiest using the command `invoke update-translations` within the root dir of the project.
179179
This will basically call `pybabel extract` followed by `pybabel update` with the proper parameters.
180180

181181
Customizing the Score Matrix

docs/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ Install
6363
invoke setup
6464
6565
# create secret key to use for auth
66-
invoke create_secret_key
66+
invoke create-secret-key
6767
6868
# almost there! Customize config
6969
vi instance/config_site.py
7070
# edit:
7171
# - SQLALCHEMY_DATABASE_URI
72-
# - SECRET_KEY # from invoke create_secret_key
72+
# - SECRET_KEY # from invoke create-secret-key
7373
# - GHC_RETENTION_DAYS
7474
# - GHC_SELF_REGISTER
7575
# - GHC_NOTIFICATIONS

0 commit comments

Comments
 (0)