This API uses Google DataStore as storage, there is not local storage on Heroku or Postgres.
+We need Google DataStore because we plan to store huge amounts of activities that the user can do inside breathecode.
+Possible activities (so far): +
"breathecode_login" //every time it logs in
+"online_platform_registration" //first day using breathecode
+"public_event_attendance" //attendy on an eventbrite event
+"classroom_attendance" //when the student attent to class
+"classroom_unattendance" //when the student miss class
+"lesson_opened" //when a lessons is opened on the platform
+"office_attendance" //when the office raspberry pi detects the student
+"nps_survey_answered" //when a nps survey is answered by the student
+"exercise_success" //when student successfully tests exercise
+Any activity has the following inputs:
+ +Get recent user activity +
+Add a new user activity (requires authentication) +
POST: activity/user/{email_or_id}
+{
+ 'slug' => 'activity_slug',
+ 'data' => 'any aditional data (string or json-encoded-string)'
+}
+
+💡 Node: You can pass the cohort in the data json object and it will be possible to filter on the activity graph like this:
+
+{
+ 'slug' => 'activity_slug',
+ 'data' => "{ \"cohort\": \"mdc-iii\" }" (json encoded string with the cohort id)
+}
+Endpoints for the Cohort
+Get recent user activity +
+Endpoints for the coding_error's + +Add a new coding_error (requires authentication)
+POST: activity/coding_error/
+
+{
+ "user_id" => "my@email.com",
+ "slug" => "webpack_error",
+ "data" => "optional additional information about the error",
+ "message" => "file not found",
+ "name" => "module-not-found,
+ "severity" => "900",
+ "details" => "stack trace for the error as string"
+}
+This module take care of the academic side of breathecode: Students, Cohorts, Course (aka: Certificate), Syllabus, etc. These are some of the things you can do with the breathecode.admissions API:
+TODO: finish this documentation.
+Override previous academies +
+This app is ideal for running diagnostic and reminders on the breathecode platform.
+Setup the monitor app job for once a day, this is the command: +
+Setup the monitor script job for once a day, this is the command: +
+A monitoring script is something that you want to execute recurrently withing the breathecode API, for example:
+scripts/alert_pending_leads.py is a small python script that checks if there is FormEntry Marketing module database that are pending processing.
You can create a monitoring script to remind academy staff members about things, or to remind students about pending homework, etc.
+./breathecode/monitoring/scripts#!/usr/bin/env python
+"""
+Alert when there are Form Entries with status = PENDING
+"""
+from breathecode.utils import ScriptNotification
+# start your code here
+ScriptNotification to notify for MINOR or CRITICAL reasons, for example:# here we are raising a notification because there are 2 pending tasks
+raise ScriptNotification("There are 2 pending taks", status='MINOR', slug="pending_tasks")
+There are some global variables that you have available during your scripts:
+| Variable name | +Value | +
|---|---|
| academy | +Contains the academy model object, you can use it to retrieve the current academy id like this: query.filter(academy__id=academy.id) |
+
You can test your scripts by running the following command:
+$ python manage.py run_script <file_name>
+
+# For example you can test the alert_pending_leads script like this:
+$ python manage.py run_script alert_pending_leads.py
+The following script checks for pending leads to process:
+#!/usr/bin/env python
+"""
+Alert when there are Form Entries with status = PENDING
+"""
+from breathecode.marketing.models import FormEntry
+from django.db.models import Q
+from breathecode.utils import ScriptNotification
+
+# check the database for pending leads
+pending_leads = FormEntry.objects.filter(storage_status="PENDING").filter(Q(academy__id=academy.id) | Q(location=academy.slug))
+
+# trigger notification because pending leads were found
+if len(pending_leads) > 0:
+ raise ScriptNotification(f"Warning there are {len(pending_leads)} pending form entries", status='MINOR')
+
+# You can print this and it will show on the script results
+print("No pending leads")
+from breathecode.monitoring.actions import run_script
+script = run_script(model.monitor_script)
+
+del script['slack_payload']
+del script['title']
+
+expected = {'details': script['details'],
+ 'severity_level': 5,
+ 'status': script['status'],
+ 'text': script['text']
+ }
+
+self.assertEqual(script, expected)
+
+self.assertEqual(self.all_monitor_script_dict(), [{
+ **self.model_to_dict(model, 'monitor_script'),
+}])
+
| name | +description | +
|---|---|
| ENV | +Represents the current environment, can be DEVELOPMENT, TEST, and PRODUCTION |
+
| LOG_LEVEL | +Represents the log level for the logging module, can be NOTSET, DEBUG, INFO, WARNING, ERROR and CRITICAL |
+
| DATABASE_URL | +Represents the connection string to the database, you can read more about schema url | +
| CACHE_MIDDLEWARE_MINUTES | +Represents how long an item will last in the cache | +
| API_URL | +Represents the url of api rest | +
| ADMIN_URL | +Represents the url of frontend of the admin | +
| APP_URL | +Represents the url of frontend of the webside | +
| REDIS_URL | +Represents the url of Redis | +
| CELERY_TASK_SERIALIZER | +Represents the default serialization method to use. Can be pickle json, yaml, msgpack or any custom serialization methods |
+
| EMAIL_NOTIFICATIONS_ENABLED | +Represents if the server can send notifications through email | +
| SYSTEM_EMAIL | +Represents the email of Breathecode for support |
+
| GITHUB_CLIENT_ID | +Represents the client id used for the OAuth2 with Github |
+
| GITHUB_SECRET | +Represents the secret used for the OAuth2 with Github |
+
| GITHUB_REDIRECT_URL | +Represents the redirect url used for the OAuth2 with Github |
+
| SLACK_CLIENT_ID | +Represents the client id used for the OAuth2 with Slack |
+
| SLACK_SECRET | +Represents the secret used for the OAuth2 with Slack |
+
| SLACK_REDIRECT_URL | +Represents the redirect url used for the OAuth2 with Slack |
+
| MAILGUN_API_KEY | +Represents the api key used for the OAuth2 with Mailgun |
+
| MAILGUN_DOMAIN | +Represents the domain of Breathecode that provided Mailgun |
+
| EVENTBRITE_KEY | +Represents the key used for the OAuth2 with Eventbrite |
+
| FACEBOOK_VERIFY_TOKEN | +Represents the verify token used for the OAuth2 with Facebook |
+
| FACEBOOK_CLIENT_ID | +Represents the client id used for the OAuth2 with Facebook |
+
| FACEBOOK_SECRET | +Represents the secret used for the OAuth2 with Facebook |
+
| FACEBOOK_REDIRECT_URL | +Represents the redirect url used for the OAuth2 with Facebook |
+
| ACTIVE_CAMPAIGN_KEY | +Represents the key used for the OAuth2 with Active Campaign |
+
| ACTIVE_CAMPAIGN_URL | +Represents the domain of Breathecode that provided Active Campaign |
+
| GOOGLE_APPLICATION_CREDENTIALS | +Represents the file will be saved the service account of Google Cloud |
+
| GOOGLE_SERVICE_KEY | +Represents the content of the service account used for the OAuth2 with Google Cloud |
+
| GOOGLE_PROJECT_ID | +Project ID on google cloud used for the integration of the entire API | +
| GOOGLE_CLOUD_KEY | +Represents the key used for the OAuth2 with Google Cloud |
+
| GOOGLE_CLIENT_ID | +Represents the client id used for the OAuth2 with Google Cloud |
+
| GOOGLE_SECRET | +Represents the secret used for the OAuth2 with Google Cloud |
+
| GOOGLE_REDIRECT_URL | +Represents the redirect url used for the OAuth2 with Google Cloud |
+
| DAILY_API_KEY | +Represents the api key used for the OAuth2 with Daily |
+
| DAILY_API_URL | +Represents the domain of Breathecode that provided Daily |
+
| SAVE_LEADS | +Represents if Breathecode will persist the leads | +
| COMPANY_NAME | +Represents the company name | +
| COMPANY_CONTACT_URL | +Represents the company contact url | +
| COMPANY_LEGAL_NAME | +Represents the company legal name | +
| COMPANY_ADDRESS | +Represents the company address | +
| MEDIA_GALLERY_BUCKET | +Represents the bucket for the media gallery | +
| DOWNLOADS_BUCKET | +Represents the bucket for the CSV files | +
| PROFILE_BUCKET | +Represents the bucket for profile avatars | +