Skip to content

cli620/tree-huggers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tree Huggers

Hackathon with MHL and digital ocean 12 12 2025

Prerequisites

  • Python (using 3.13)
  • Git

Installation

1. Clone the Repository

git clone https://github.com/cli620/tree-huggers.git
cd tree-huggers

2. Install uv

uv is a fast Python package manager. Install it using one of the following methods: Alternative (using pip):

pip install uv

3. Sync Dependencies

Install all project dependencies using uv:

uv sync

This will read your pyproject.toml and install all required packages.

Configuration

Environment Variables

Create a .env file in the root directory of the project:

cp .env.example .env

Then edit .env and add your configuration:

GRADIENT_AGENT_ACCESS_KEY = ...
GRADIENT_AGENT_ENDPOINT = ...
GRADIENT_MODEL_ACCESS_KEY = ...

Important: Never commit your .env file to version control. It's already included in .gitignore.

Running the Application

Start the Server

uv run uvicorn app.main:app --reload

The --reload flag enables auto-reloading during development.

Access the Application

Once the server is running, you can access:

Common Commands

Update Dependencies

If dependencies have changed:

uv sync

Add a New Package

uv add package-name

Run Linting/Tests

uv run pytest                    # Run tests
uv run ruff check .              # Run linting
uv run black .                   # Format code

Project Structure

.
├── app/
│   ├── main.py              # Application entry point
│   ├── api/                 # API routes
│   ├── models/              # Database models
│   └── utils/               # Utility functions
├── tests/                   # Test files
├── .env                     # Environment variables (not in git)
├── .env.example             # Example environment file
├── pyproject.toml           # Project dependencies
└── README.md                # This file

Troubleshooting

Port Already in Use

If port 8000 is already in use, specify a different port:

uv run uvicorn app.main:app --reload --port 8001

Missing Environment Variables

If you get errors about missing environment variables, ensure your .env file is properly configured with all required values.

Dependency Issues

If you encounter dependency conflicts:

uv sync --reinstall

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors