Python core
Modules organised by responsibility, following best practices and ready for future test coverage.
A local voice assistant with contextual memory and bespoke integrations for routines, projects, and personal automations.
The project was created to manage routines, calendars, and projects without exposing sensitive data to external services. Everything runs on the user machine.
Decoupled components allow future swaps (local LLMs, new TTS, external agendas) without rewriting the project.
Modules organised by responsibility, following best practices and ready for future test coverage.
Transcription with Whisper API and synthesis via Edge TTS, keeping operational costs low.
GPT-3.5-turbo integration with vector memory plans via FAISS.
Each folder holds an isolated layer (input, output, memory, data), simplifying maintenance and extensions.
edu_assistant/
โโโ main.py # Voice/text interface
โโโ config.json # Credentials and preferences
โโโ memory/ # Local memory, agenda, and vectors
โโโ data/projects/ # Project metadata
โโโ modules/
โ โโโ voice_input.py # Whisper API
โ โโโ voice_output.py # Edge TTS
โ โโโ gpt_client.py # Model calls
โ โโโ context_loader.py# Context inputs
โ โโโ agenda.py # Daily routine
โ โโโ actions.py # Automation actions
โโโ requirements.txt # Main dependencies
Follow the steps to prepare your environment, credentials, and start the conversational flow on desktop.
git clone https://github.com/eduardo45MP/edu_assistant.git
cd edu_assistant
python3 -m venv venv
source venv/bin/activate # Linux/macOS
# .\venv\Scripts\activate # Windows
pip install -r requirements.txt
cp config.example.json config.json
# Fill in API keys, preferences, and local paths
python main.py
Switch to text-only mode by replacing audio capture with CLI input if you do not have a microphone available.
Suggestions and PRs are welcome, especially for offline support, new integrations, and UX.
Connect external calendars, email services, or productivity platforms.
Explore local LLMs (Ollama, LM Studio) and open-source STT/TTS options.
Build desktop/mobile interfaces or web dashboards to monitor the assistant in real time.
Keep the visual identity standards described in portfolio/docs/visualID.md and follow ROADMAP.md to align contributions with current priorities.