Merge pull request #84 from Tanzania-AI-Community/release/v0.1.0

Release/v0.1.0

Author: fredygerman

.env.template

@@ -1,7 +1,7 @@
 """META API credentials"""
 
 # Meta's Graph API version
-META_API_VERSION=21.0
+META_API_VERSION="v22.0"
 
 # Meta's identifier for the Twiga app
 META_APP_ID=
@@ -18,9 +18,6 @@ WHATSAPP_VERIFY_TOKEN=
 # Access token to use the WhatsApp Business API (use either 24hr or 60 day token)
 WHATSAPP_API_TOKEN=
 
-# Limit of messages that can be sent by the Twiga bot in a day (adjust to your liking)
-DAILY_MESSAGE_LIMIT=100
-
 """LLM API credentials"""
 
 # API Key for the LLM provider (either OpenAI or Together AI)
@@ -29,18 +26,28 @@ LLM_API_KEY=
 """Database Credentials"""
 
 # Postgres database URL
+DATABASE_USER=
+DATABASE_PASSWORD=
+DATABASE_NAME=
 DATABASE_URL=
 
+"""App configuration"""
+ENVIRONMENT="local"
+DEBUG=True
+
 """Below credentials are only required when using WhatsApp Flows in a verified Business account (if unsure, leave empty)"""
-# Set to True if you want to use WhatsApp Flows in a verified business account
-BUSINESS_ENV=False
+# For when ENVIRONMENT is set to "production", "staging", or "development"
 
 # Specific credentials for WhatsApp Flows
 WHATSAPP_BUSINESS_PUBLIC_KEY=
 WHATSAPP_BUSINESS_PRIVATE_KEY=
 WHATSAPP_BUSINESS_PRIVATE_KEY_PASSWORD=
-PERSONAL_AND_SCHOOL_INFO_FLOW_ID=
-SELECT_SUBJECTS_FLOW_ID=
+ONBOARDING_FLOW_ID=
+SUBJECTS_CLASSES_FLOW_ID=
 FLOW_TOKEN_ENCRYPTION_KEY=
 
+# For when ENVIRONMENT is set to "staging" or "production"
+# Redis for rate limiting
+REDIS_URL=redis://localhost:6379
+
 # NOTE: Remove all comments and fill in the values for the environment variables

.gitignore

@@ -129,10 +129,8 @@ venv/
 ENV/
 env.bak/
 venv.bak/
-.env.local
-.env.production
-.env.development
-.env.test
+.env.*
+!.env.template
 
 # Spyder project settings
 .spyderproject
@@ -168,5 +166,6 @@ cython_debug/
 ##################### New Additions #####################
 # Ignore DS_Store files
 .DS_Store
-private.pem
-public.pem
+
+# ignore .pem files
+*.pem

.pre-commit-config.yaml

@@ -1,27 +1,27 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-fail_fast: true
-default_stages: [pre-commit]
-
-repos:
-  - repo: https://github.com/psf/black
-    rev: 24.10.0
-    hooks:
-      - id: black
-        args: [--config, pyproject.toml]
-        types: [python]
-
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.7.3"
-    hooks:
-      - id: ruff
-        args: [--fix, --exit-non-zero-on-fix]
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-      - id: check-toml
-      - id: check-yaml
-      - id: detect-private-key
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+fail_fast: true
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        args: [--config, pyproject.toml]
+        types: [python]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.7.3"
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

Dockerfile

@@ -0,0 +1,19 @@
+build:
+	@echo 'Building images ...'
+	@docker-compose -f docker/dev/docker-compose.yml --env-file .env build --no-cache
+
+run:
+	@echo 'Running containers ...'
+	@docker-compose -f docker/dev/docker-compose.yml --env-file .env up -d
+
+stop:
+	@echo 'Stopping containers ...'
+	@docker-compose -f docker/dev/docker-compose.yml down
+
+restart: stop run
+
+generate-local-data:
+	@echo 'Generating local data ...'
+	@docker-compose -f docker/dev/docker-compose.yml --env-file .env run --rm app bash -c "PYTHONPATH=/app uv run python scripts/database/seed.py --create --sample-data --vector-data chunks_BAAI.json"
+
+setup-env: build generate-local-data run

Makefile

@@ -4,6 +4,7 @@
 
 import logging
 from colorlog import ColoredFormatter
+from app.config import settings
 
 # Configure color logging
 formatter = ColoredFormatter(
@@ -26,7 +27,10 @@
 
 # Get the root logger and set its level
 logger = logging.getLogger()
-logger.setLevel(logging.DEBUG)  # set to DEBUG for more verbose logging
+if settings.debug:
+    logger.setLevel(logging.DEBUG)
+else:
+    logger.setLevel(logging.INFO)
 
 
 # Clear existing handlers and set the new handler

app/__init__.py

@@ -1,13 +1,8 @@
-You are a skilled Tanzanian secondary school teacher that generates questions or exercises for Tanzanian Form 2 geography students based on the request made by the user. Use the provided context from the textbook to ensure that the questions you generate are grounded in the course content. Given the context information and not prior knowledge, follow the query instructions provided by the user. Don't generate questions if the query topic from the user is not related to the course content. Begin your response immediately with the question.
+You are a skilled Tanzanian secondary school teacher that generates questions or exercises for students based on the request made by the user. This exercise is for {class_info} students. Use the provided context from the textbook to ensure that the questions you generate are grounded in the course content. Take inspiration from the example exercises from the textbook if they are provided to you. Given the context information and not prior knowledge, follow the query instructions provided by the user. Don't generate questions if the query topic from the user is not related to the course content. Begin your response immediately with the question.
 
 EXAMPLE INTERACTION:
 user: Follow these instructions (give me short answer question on Tanzania's mining industry)
 Context information is below.
-
-START
-
 Tanzania has many minerals that it trades with to other countries...etc.
 
-END
-
 assistant: List three minerals that Tanzania exports.

app/assets/prompts/exercise_generator_system

@@ -1,12 +1,17 @@
-You are Twiga, a WhatsApp bot developed by the Tanzania AI Community specifically for secondary school teachers in Tanzania. Your role is to support teachers by providing accurate, curriculum-aligned educational assistance in a professional and supportive tone.
+You are Twiga, a WhatsApp bot developed by the Tanzania AI Community for secondary school teachers in Tanzania. The curriculum is the Tanzanian National Curriculum, developed by the Tanzanian Institute of Education (TIE). The students are assessed in NECTA examinations, which cover the curriculum. TIE are also the writers of the textbooks you use. Your role is to support the teachers by providing accurate, curriculum-aligned educational assistance. You are talking to {user_name} who teaches {class_info}.
 
-You are talking to {user_name} who teaches {class_info}
+Follow these instructions:
 
-Note that os2 refers to Ordinary Secondary Level 2, which is equivalent to Form 2 in the Tanzanian education system.
+- You only communicate in english
+- Use the tools you have available
+- Be clear and concise, since your messages are communicated on WhatsApp
+- Ask the teacher for additional information or clarification if its needed
+- Do not generate educational content if they are not provided by your tools
+- If the tool has an error or does not fulfill the user request, tell the user
+- Only help the teacher with subject related matter
 
-Follow these core guidelines:
+Here are your capabilities:
 
-Guidelines:
-Use Available Tools: For subject-related queries, refer to the tools available to you, unless the query is straightforward or involves general knowledge.
-Clarity and Conciseness: Ensure all responses are clear, concise, and easy to understand.
-Seek Clarification: If a query is unclear, kindly ask the user for additional details to provide a more accurate response.
+1. Searching the textbooks to answer course-related questions
+2. Generating example exercises or questions based on a specific course-related topic
+3. General tips and support

app/assets/prompts/twiga_system

@@ -20,8 +20,8 @@ settings:
   class_subject_info: "Classes and Subjects"
 
 tools:
-  exercise_generator: "🏋️ Generating an exercise using the course literature, please hold..."
-  search_knowledge: "🔍 Searching for relevant knowledge, please hold..."
+  generate_exercise: "📑 Generating exercises from the course content, please hold..."
+  search_knowledge: "📚 Searching the course content, please hold..."
 
 flows:
   start_onboarding_header: "Start onboarding to Twiga 🦒"
@@ -30,10 +30,10 @@ flows:
   personal_settings_header: "Update your personal and school information 📝"
   personal_settings_body: "Let's update your personal and school information."
   personal_settings_cta: "Personal Settings"
-  subjects_flow_header: "Select your subjects 📚"
-  subjects_flow_body: "Fill this form to select the subjects you teach."
-  subjects_flow_cta: "Subjects"
-  select_subjects_text: "This helps us find the best answers for your questions."
-  classes_flow_header: "Select your {subject} classes"
-  classes_flow_body: "Fill this form to select the classes you teach."
-  classes_flow_cta: "Classes"
+  subjects_classes_flow_header: "Select the classes you teach 📚"
+  subjects_classes_flow_body: "Select the classes you teach from each of the subjects below"
+  subjects_classes_flow_cta: "Classes"
+
+rate_limit:
+  global_message_limit: "🚫 Twiga is currently unavailable. Please come back later."
+  user_message_limit: "🚫 You have reached your daily messaging limit, so Twiga 🦒 is quite sleepy from all of today's texting 🥱. Come back later!"