No description
- Python 99.1%
- HTML 0.5%
- Shell 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Alexander Siol
5d621383bb
The default ranking now leans everyone-can-join (coverage at 4) and
deliberate intent (favorites at 2) instead of the historical
equal-weight formula — a developer baseline ('for now') to iterate on
with the debug-menu experiments. The old ranking survives as the
explicit vector 1/1/1/0 and stays pinned by test; score/order
expectations across the endpoint, scoring, and visibility suites moved
with the retune.
|
||
| dev | ||
| docs/decisions | ||
| migrations | ||
| src/gw2suggest | ||
| tests | ||
| .gitignore | ||
| AGENTS.md | ||
| alembic.ini | ||
| IDEAS.md | ||
| LICENSE | ||
| opencode.json | ||
| pyproject.toml | ||
| README.md | ||
| uv.lock | ||
GW2 Suggest API
GW2 Suggest is a companion web application for Guild Wars 2 that helps groups of players find achievements to tackle together.
Tech Stack
- FastAPI: Web framework.
- SQLAlchemy 2.0: ORM (using async support).
- Alembic: Database migrations.
- Pydantic v2: Data validation and settings.
- Celery: Background tasks.
- sqladmin: Admin interface.
- SQLite: Default development database.
Getting Started
Prerequisites
- Python 3.13+
- uv (recommended)
Installation
-
Clone the repository:
git clone <repository-url> cd gw2suggest-api -
Install dependencies:
uv sync
Running the Application
-
Start the development server:
uv run uvicorn gw2suggest.main:app --reload -
Start the Celery worker (requires Redis):
# In a new terminal $env:PYTHONPATH="src" uv run celery -A gw2suggest.celery_app worker --loglevel=info
The API will be available at http://127.0.0.1:8000.
Swagger documentation: http://127.0.0.1:8000/docs.
Database Migrations
Apply migrations to your local SQLite database:
uv run alembic upgrade head
Running Tests
uv run pytest
Linting and Formatting
uv run ruff check .
uv run ruff format .
Manual Testing with .http file
You can use tests/test_main.http for quick manual testing of the endpoints. This file is compatible with:
- PyCharm: Built-in HTTP Client. Open the file and click the green "Run" arrow next to requests.
- VS Code: Install the REST Client extension to execute requests directly from the editor.
- JetBrains IDEs: Any JetBrains IDE (IntelliJ, WebStorm, etc.) supports this format out of the box.
Documentation
See AGENTS.md for detailed development guidelines and best practices.