gal
/
berlin-picnic-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6 Commits 1 Branch 0 Tags 12 MiB
Python 99.5%
Jupyter Notebook 0.5%
Go to file
Gal 49e3d8c29d
Add real green space data and neighborhood filtering 		2025-06-21 22:58:50 +02:00
app Add real green space data and neighborhood filtering 2025-06-21 22:58:50 +02:00
scripts Add real green space data and neighborhood filtering 2025-06-21 22:58:50 +02:00
tests first commit 2025-06-17 16:08:25 +02:00
.gitignore add basic models and toilet 2025-06-18 22:14:26 +02:00
.python-version first commit 2025-06-17 16:08:25 +02:00
README.md add basic models and toilet 2025-06-18 22:14:26 +02:00
hello.py first commit 2025-06-17 16:08:25 +02:00
pyproject.toml Add real green space data and neighborhood filtering 2025-06-21 22:58:50 +02:00

README.md

Berlin Picnic Zone Finder API

Find the perfect picnic zones in Berlin based on your personality and preferences.

🚀 Quick Start

Prerequisites

  • Python 3.11+
  • uv package manager

Installation

# Clone the repository
git clone https://github.com/yourusername/berlin-picnic-api.git
cd berlin-picnic-api

# Install dependencies
uv sync --dev

# Create environment file
cp .env.example .env

# Start the development server
uv run uvicorn app.main:app --reload

The API will be available at http://localhost:8000

📚 API Documentation

🏗️ Project Structure

app/
├── main.py              # FastAPI application
├── config.py            # Configuration settings
├── models/              # Pydantic models
├── services/            # Business logic
├── utils/               # Utility functions
├── routers/             # API route handlers
└── data/                # Data storage

🔧 Development

Code Quality

# Format code
uv run ruff format .

# Lint code
uv run ruff check . --fix

# Type checking
uv run mypy app/

# Run tests
uv run pytest

# Run all checks
uv run ruff check . && uv run ruff format . && uv run mypy app/ && uv run pytest

Data Management

# Fetch Berlin open data
uv run python scripts/fetch_berlin_data.py

# Process zone data
uv run python scripts/process_zones.py

🌍 API Endpoints

Zones

  • GET /zones - Get zones filtered by personality and preferences
  • GET /zones/{zone_id} - Get specific zone details
  • GET /zones/{zone_id}/scores - Get personality scores for a zone

Neighborhoods

  • GET /neighborhoods - Get all Berlin neighborhoods

Health

  • GET /health - Basic health check
  • GET /health/ready - Readiness check

🎯 Personality Types

  • little_adventurers - Families with kids
  • date_night - Romantic couples
  • squad_goals - Friend groups
  • zen_masters - Peace seekers
  • active_lifestyle - Fitness enthusiasts
  • wildlife_lover - Nature enthusiasts
  • art_nerd - Art and culture lovers
  • history_geek - History enthusiasts

🗺️ Berlin Neighborhoods

  • Mitte, Kreuzberg, Friedrichshain, Prenzlauer Berg
  • Charlottenburg, Wilmersdorf, Schöneberg, Tempelhof
  • Neukölln, Pankow, Wedding, Moabit

📊 Scoring Factors

  • Tree coverage and shade
  • Noise levels
  • Wildlife diversity
  • Nearby amenities (Späti, restaurants, toilets)
  • Playgrounds and water features
  • Public transport accessibility
  • Fitness facilities and paths

🚀 Deployment

Docker

# Build image
docker build -t berlin-picnic-api .

# Run container
docker run -p 8000:8000 berlin-picnic-api

Docker Compose

# Start all services
docker-compose up -d

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting
  5. Submit a pull request

📄 License

MIT License - see LICENSE file for details

📞 Support