|
7 | 7 | A Django package for creating email-based learning platforms with IMAP integration and React frontend components. |
8 | 8 |
|
9 | 9 | [](https://opensource.org/licenses/BSD-3-Clause) |
10 | | -[](https://www.python.org/downloads/) |
| 10 | +[](https://www.python.org/downloads/) |
11 | 11 | [](https://www.djangoproject.com/) |
12 | 12 |  |
13 | 13 |
|
@@ -50,9 +50,9 @@ A quick look at the platform interface: |
50 | 50 |
|
51 | 51 | | Course Dashboard | Public Organization Page | |
52 | 52 | | --- | --- | |
53 | | -|  |  | |
| 53 | +|  |  | |
54 | 54 | | Learner Progress | Certificate | |
55 | | -|  |  | |
| 55 | +|  |  | |
56 | 56 |
|
57 | 57 |
|
58 | 58 | ## Documentation |
@@ -91,10 +91,13 @@ Add the required configuration for the site base URL in your Django settings: |
91 | 91 |
|
92 | 92 | ```python |
93 | 93 | DJANGO_EMAIL_LEARNING = { |
94 | | - "SITE_BASE_URL": "<YOUR_SITE_BASE_URL_STARTING_WITH_HTTP>" |
| 94 | + "SITE_BASE_URL": "<YOUR_SITE_BASE_URL_STARTING_WITH_HTTP>", |
| 95 | + "ENCRYPTION_SECRET_KEY": "<LONG_RANDOM_STRING>", |
95 | 96 | } |
96 | 97 | ``` |
97 | 98 |
|
| 99 | +`ENCRYPTION_SECRET_KEY` should be a long random string used to protect sensitive values such as stored API Keys. |
| 100 | + |
98 | 101 | ### 4. Configure Media Files |
99 | 102 |
|
100 | 103 | This app uses Django's MEDIA files to save organization logos. Ensure your media settings are configured correctly. See the [MEDIA_URL setting](https://docs.djangoproject.com/en/6.0/ref/settings/#media-url) for details. |
@@ -138,6 +141,15 @@ Execute the content delivery job using: |
138 | 141 | python manage.py deliver_contents |
139 | 142 | ``` |
140 | 143 |
|
| 144 | +You can also trigger this job via API, which is useful when running from an external scheduler (for example, cloud scheduler services): |
| 145 | + |
| 146 | +```http |
| 147 | +GET /your_preferred_path/api/jobs/deliver_contents/ |
| 148 | +Authorization: Bearer <API_KEY> |
| 149 | +``` |
| 150 | + |
| 151 | +This endpoint requires an API key. You can generate and manage API keys from Platform Settings > API Keys in the platform UI. |
| 152 | + |
141 | 153 | ## Contributing |
142 | 154 |
|
143 | 155 | We welcome contributions! Please read our [Contributing Guide](https://github.com/AvaCodeSolutions/django-email-learning/blob/master/CONTRIBUTING.md) to learn about our development process, how to set up the development environment, and how to submit pull requests. |
|
0 commit comments