Skip to content

overtron/Tutorial-Codebase-Knowledge

 
 

Repository files navigation

Tutorial Codebase Knowledge

Project Setup

This project uses Anthropic Claude 3.7 for LLM functionality.

Setup with Scripts

On macOS/Linux:

  1. Run the setup script:
    ./setup.sh
  2. The script will:
    • Create and activate a virtual environment
    • Install dependencies
    • Prompt you for your Anthropic API key
    • Create a .env file with your API key

On Windows:

  1. Run the setup script:
    setup.bat
    
  2. The script will:
    • Create and activate a virtual environment
    • Install dependencies
    • Prompt you for your Anthropic API key
    • Create a .env file with your API key

Manual Setup

If you prefer to set up manually:

  1. Create a virtual environment:

    python -m venv venv
  2. Activate the virtual environment:

    • On macOS/Linux:
      source venv/bin/activate
    • On Windows:
      venv\Scripts\activate
      
  3. Install dependencies:

    pip install -r requirements.txt
  4. Create a .env file with your Anthropic API key:

    ANTHROPIC_API_KEY=your_api_key_here
    ANTHROPIC_MODEL=claude-3-7-sonnet-20250219
    

Testing the Setup

To test that the LLM is working correctly:

python -m utils.call_llm

This will make three API calls to Claude 3.7:

  1. First call with caching enabled (cache miss)
  2. Second call with caching enabled (cache hit)
  3. Third call with caching disabled (API call)

Model Configuration

The default model is set to claude-3-7-sonnet-20250219. If this model identifier is incorrect or you want to use a different Anthropic model, update the ANTHROPIC_MODEL variable in your .env file.

About

Turns Codebase into Easy Tutorial with AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%