Spaces:
Running
Running
Richard Fan
commited on
Commit
·
e7cab8d
1
Parent(s):
3cff6fb
updated readme
Browse files
README.md
CHANGED
@@ -96,11 +96,11 @@ If you do not wish to fork this repository, and would prefer to clone and run it
|
|
96 |
2. Modify the configuration file `config.yaml`
|
97 |
3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
|
98 |
4. Create or fetch your api key for [SendGrid](https://app.SendGrid.com/settings/api_keys) (optional, if you want the script to email you)
|
99 |
-
5. Set the following secrets
|
100 |
- `OPENAI_API_KEY`
|
101 |
- `SENDGRID_API_KEY` (only if using SendGrid)
|
102 |
-
- `FROM_EMAIL` (only if using SendGrid and if you don't have
|
103 |
-
- `TO_EMAIL` (only if using SendGrid and if you don't have
|
104 |
6. Run `python action.py`.
|
105 |
7. If you are not using SendGrid, the html of the digest will be written to `digest.html`. You can then use your favorite webbrowser to view it.
|
106 |
|
@@ -108,7 +108,7 @@ You may want to use something like crontab to schedule the digest.
|
|
108 |
|
109 |
### Running with a user interface
|
110 |
|
111 |
-
Install the requirements in `src/requirements.txt` as well as `gradio`. Set the evironment variables `OPENAI_API_KEY`, `FROM_EMAIL` and `SENDGRID_API_KEY`
|
112 |
|
113 |
Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.
|
114 |
|
|
|
96 |
2. Modify the configuration file `config.yaml`
|
97 |
3. Create or fetch your api key for [OpenAI](https://platform.openai.com/account/api-keys). Note: you will need an OpenAI account.
|
98 |
4. Create or fetch your api key for [SendGrid](https://app.SendGrid.com/settings/api_keys) (optional, if you want the script to email you)
|
99 |
+
5. Set the following secrets as environment variables:
|
100 |
- `OPENAI_API_KEY`
|
101 |
- `SENDGRID_API_KEY` (only if using SendGrid)
|
102 |
+
- `FROM_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`. Note that this value must match the email you used to create the SendGrid Api Key.)
|
103 |
+
- `TO_EMAIL` (only if using SendGrid and if you don't have it set in `config.yaml`)
|
104 |
6. Run `python action.py`.
|
105 |
7. If you are not using SendGrid, the html of the digest will be written to `digest.html`. You can then use your favorite webbrowser to view it.
|
106 |
|
|
|
108 |
|
109 |
### Running with a user interface
|
110 |
|
111 |
+
Install the requirements in `src/requirements.txt` as well as `gradio`. Set the evironment variables `OPENAI_API_KEY`, `FROM_EMAIL` and `SENDGRID_API_KEY`. Ensure that `FROM_EMAIL` matches `SENDGRID_API_KEY`.
|
112 |
|
113 |
Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.
|
114 |
|