relates to #14, updated more broken links in README
This commit is contained in:
Родитель
ee671c4539
Коммит
e61151b792
|
@ -1,6 +1,6 @@
|
|||
# Schedule App Data Processor
|
||||
|
||||
This script is designed as a data processor helper for [schedule app core](https://github .com/mozilla /schedule-app- core/).
|
||||
This script is designed as a data processor helper for [schedule app core](https://github.com/mozilla/schedule-app-core/).
|
||||
|
||||
It handles the following tasks
|
||||
|
||||
|
@ -13,8 +13,7 @@ It handles the following tasks
|
|||
## To run the script
|
||||
|
||||
1. Create a Python virtual environment and install all the required packages. See
|
||||
[create a Python virtual environment docs](https://github.com/mozilla/schedule-app-data-processor#create-a-python-virtual-environment) for instructions.
|
||||
2. Get API creds from GitHub and Google. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor#authentication) for instructions.
|
||||
[create a Python virtual environment docs](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#create-a-python-virtual-environment) for instructions.
|
||||
2. Get API creds from GitHub and Google. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#authentication) for instructions.
|
||||
3. Set values for [environment variables](https://github.com/mozilla/schedule-app-data-processor#environment-variables) and run `source your-file-name.env`
|
||||
4. Running **`update_schedule()`** will execute [these methods](https://github.com/mozilla/schedule-app-data-processor#primary-methods-of-the-script) in succession. You can trigger
|
||||
it from the command line: **`python update_schedule.py`**
|
||||
4. Running **`update_schedule()`** will execute [these methods](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#primary-methods-of-the-script) in succession. You can trigger it from the command line: **`python update_schedule.py`**
|
||||
|
|
|
@ -26,7 +26,7 @@ Follow these instructions to create *a service account*: https://developers.goog
|
|||
|
||||
Creating a service account will generate a special client email address and
|
||||
a new private key. The client email address should be stored in an environment
|
||||
variable called [`GOOGLE_API_CLIENT_EMAIL`](https://github.com/mozilla/schedule-app-data-processor#environment-variables). The private key should be stored in an environment variable called [`GOOGLE_API_PRIVATE_KEY`](https://github.com/mozilla/schedule-app-data-processor#environment-variables).
|
||||
variable called [`GOOGLE_API_CLIENT_EMAIL`](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#environment-variables). The private key should be stored in an environment variable called [`GOOGLE_API_PRIVATE_KEY`](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#environment-variables).
|
||||
|
||||
## Project settings
|
||||
|
||||
|
@ -40,9 +40,9 @@ copying [sample.env](https://github.com/mozilla/schedule-app-data-processor/blob
|
|||
| **`REPO_OWNER`** | A string representing the GitHub username of the account that,owns the repository you want to commit to |
|
||||
| **`REPO_NAME`** | A string representing the name of the repository to commit to |
|
||||
| **`TARGET_DIR`** | Name of the directory you are committing `sessions.json` file to. Leave blank or omit this variable if `sessions.json` is going to live on root directory. |
|
||||
| **`GITHUB_TOKEN`** | Your GitHub token. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor#authentication) on how to acquire a GitHub token. |
|
||||
| **`GOOGLE_API_CLIENT_EMAIL`** | Your Google API client email. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor#authentication) on how to create a Google service account. |
|
||||
| **`GOOGLE_API_PRIVATE_KEY`** | Your Google API private key. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor#authentication) on how to create a Google service account. |
|
||||
| **`GITHUB_TOKEN`** | Your GitHub token. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#authentication) on how to acquire a GitHub token. |
|
||||
| **`GOOGLE_API_CLIENT_EMAIL`** | Your Google API client email. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#authentication) on how to create a Google service account. |
|
||||
| **`GOOGLE_API_PRIVATE_KEY`** | Your Google API private key. See [authentication docs](https://github.com/mozilla/schedule-app-data-processor/blob/master/docs/REQUIREMENTS.md#authentication) on how to create a Google service account. |
|
||||
| **`GOOGLE_SPREADSHEET_KEY`** | A string representing the unique ID of the Google spreadsheet storing your data. |
|
||||
| **`WORKSHEETS_TO_FETCH`** | if `FETCH_MULTIPLE_WORKSHEETS` is set to `True`, you may define a list of worksheet names to fetch data from. e.g. `['Template', '(backup data)']` |
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче