Kronicle is a FastAPI-based time-series storage service with strict separation of admin, writer, and reader permissions. The API is organized into three main route groups: Setup/Admin, Writer/Data, and Reader/API.

Base URL prefixes include the API version:

• /setup/v1 → Admin/setup routes
• /data/v1 → Writer/data routes
• /api/v1 → Reader/read-only routes

Here is the full updated API (as an OpenAPI JSON)

If the server is launched, you can get an interactive Swagger at http://localhost:8000/docs

These routes are intended for administrators or users with full access to manage channels.

These routes are primarily for appending sensor data and managing metadata safely. Writers have read-only access for exploration.

These routes are read-only and safe for public or restricted clients.

• Immutable Data: Sensor data rows are append-only once inserted.
• Metadata: Includes schema, tags, and additional sensor metadata.
• Permissions:
  • Setup routes require admin access.
  • Writer routes allow appending data plus safe reads.
  • Reader routes are read-only.

brew install postgresql@17 timescaledb

# Start Postgres
brew services start postgresql@17

# You can check if it is running correctly with
pg_ctl -D /opt/homebrew/var/postgresql@17 status
# or
brew services list

# Add this is your ~/.zshrc
export PATH="/opt/homebrew/opt/postgresql@17/bin:$PATH"
export PGDATA="/opt/homebrew/var/postgresql@17"

# Then
source ~/.zshrc


# By default, postgres role is created. You can create your own user and DB
createuser --interactive            # prompts for username & superuser? yes/no
createdb mydb              # creates a database owned by your new user
psql mydb                  # now you can connect to it in psql

Inside psql

-- inside psql
\du         -- list roles/users
\l          -- list databases

See additional psql/timescaleDB commands in ./docs

-- inside psql:
CREATE EXTENSION IF NOT EXISTS timescaledb CASCADE;

If you want it enabled by default for all databases, you can edit postgresql.conf:

shared_preload_libraries = 'timescaledb'

Then restart PostgreSQL:

brew services restart postgresql@17

Verify TimescaleDB

-- inside psql
\dx
# Launch

## FastAPI server

```sh
cd src
# nodemon-like reload-on-code-change server launch
# instead of `fastapi run kronicle/main.py`
uvicorn kronicle.main:app --reload --host 0.0.0.0 --port 8000

You can then test the API with Swagger: http://localhost:8000/docs