osu!bookmarks API 📌

A modern Python project with FastAPI, SQLAlchemy, and osu! API integration.

Built With 💙

Table of Contents 📖

• Install dependencies
• Setup API keys
• Usage
• Documentation

Dependencies 🛠️

While in the projects directory, execute the following command to create a virtual environment and install dependencies:

$ uv sync

API keys 🔒

In case of questions, first refer to ossapi documentation.

1. Create OAuth client

First, we’ll need to create an OAuth client.

Navigate to your settings page and click “New OAuth Application”. You can name it anything you like, but choose a callback url on localhost. For example, http://localhost:3914/. Any port greater than 1024 is fine as long as you don’t choose something another application is using.

When you create the application, it will show you a client id and secret. Take note of these two values.

2. Edit .env file

Rename .env.example file to .env and edit accordingly:

OSU_CLIENT_ID=your_client_id
OSU_CLIENT_SECRET=your_client_secret

Usage 🖥️

Start API server by executing:

$ fastapi dev app/main.py

Documentation 📄

After running the FastAPI server, you can access documentation either via Swagger UI or ReDoc