CourseCompass is a Python-based project designed to provide tools and utilities for various AI-driven tasks, including web scraping, search engine interaction, and report generation. The project is modular, with a focus on extensibility and ease of use.
- Agent-based architecture: Includes agents for scraping, searching, and reporting.
- LLM Integration: Supports large language model (LLM) interactions for advanced AI capabilities.
- Utilities: Helper functions and tools for common tasks, such as data processing and formatting.
- Extensible Design: Modular structure for easy customization and extension, allowing developers to add new features seamlessly.
CourseCompass
├── config
├── outs
├── src
│ ├── agents
│ ├── constants
│ ├── crew
│ ├── llm
│ ├── schemas
│ ├── tasks
│ ├── tools
│ └── utils
├── template
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
-
Clone the repository:
git clone https://github.com/A-A7med-i/Course-Compass.git cd CourseCompass -
Set up the virtual environment:
python3 -m venv AI-AGENT source AI-AGENT/bin/activate -
Install dependencies:
pip install -r requirements.txt
-
Activate the virtual environment:
source AI-AGENT/bin/activate -
Run the main script:
python src/crew/main.py
To get started with CourseCompass, follow these steps:
- Ensure you have Python 3.8 or higher installed on your system.
- Follow the installation steps above to set up the project.
- Explore the
srcdirectory to understand the modular structure and available agents. - Run the main script to see the project in action.
Below is a screenshot showcasing the app's interface or functionality:
Contributions are welcome! Please fork the repository and submit a pull request. Make sure to follow the project's coding standards and include tests for any new features.
If you encounter any issues or have questions, feel free to open an issue on the GitHub repository or contact the maintainers.
This project is licensed under the terms of the LICENSE file.