livelikeabel/sophabel.ai

sophiabel.ai

Welcome to sophiabel.ai project! This project uses crewAI, a flexible and powerful AI framework that enables you to create and manage AI agents, tools, and tasks efficiently.

Table of Contents

• Introduction
• Installation
  • Prerequisites
  • Setup
• Usage
• Updating Dependencies

Introduction

This project is designed to help english teacher. Follow the steps below to set up and run the project on your local machine.

Installation

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python 3.10.12
• git installed on your machine

Setup

1. Install pyenv

   curl https://pyenv.run | bash

2. Configure pyenv Add the following lines to your ~/.bashrc or ~/.zshrc file:

   export PYENV_ROOT="$HOME/.pyenv"
   command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"
   eval "$(pyenv init --path)"
   eval "$(pyenv init -)"
   eval "$(pyenv virtualenv-init -)"

   Reload your shell configuration:

   exec "$SHELL"

3. Install Python Version

   pyenv install 3.10.12

4. Set Local Python Version

   pyenv local 3.10.12

5. Create a Virtual Environment // TODO: update to using pyenv-virtualenv

   python -m venv venv

6. Activate the Virtual Environment

   • macOS/Linux:

     source venv/bin/activate

   • Windows:

     .\venv\Scripts\activate

7. Install Dependencies

   pip install --upgrade pip
   pip install -r requirements.txt

Usage

To run the project, follow these steps:

1. Activate the virtual environment (if not already activated):

   source venv/bin/activate  # macOS/Linux
   .\venv\Scripts\activate  # Windows

2. Run your script or application

   python main.py

Updating Dependencies

If you install new packages, remember to update the requirements.txt file to include the new dependencies. This ensures that others can install the same packages and run the project without issues.

To install a new package and update requirements.txt:

1. Install the new package:

   pip install new_package

2. Update requirements.txt:

   pip freeze > requirements.txt

By following these steps, you can keep the requirements.txt file up-to-date and ensure that all dependencies are properly managed.

Thank you for using sophiabel.ai project!