Skip to content

Repository files navigation

seriousdb logo

seriousdb - A seriously simple database

seriousdb is a small, simple key-value database you can query directly over HTTP. It requires zero configuration and is designed to be effortless. For fullstack projects, seriousdb can replace your complete backend.

For setup, usage, architecture, persistence, and contribution guidance, see the documentation.

Quick Start

Use as Python library

Install using

  • pip:
pip install git+https://github.com/danieldeer/seriousdb.git

Or

  • uv:
uv add git+https://github.com/danieldeer/seriousdb.git

Then use it directly form your python project:

import seriousdb

seriousdb.set("name", "Alice")
print(seriousdb.get("name"))

Run as HTTP server

Clone the repository, install the project, and start the development server:

git clone https://github.com/danieldeer/seriousdb.git
cd seriousdb
uv sync
uv run run.py

The server is available at http://127.0.0.1:8000.

To change the default IP and PORT, define the environment variables APP_HOST and APP_PORT to your preferred values.

Interactive API documentation is available at:

Configuration

Server configuration is optional and can be customized from environment variables. Copy the example file and adjust for local development:

cp .env.example .env

The .env file is gitignored and should never be committed.

Variable Default Description
SERIOUSDB_DB_FILE .sdb Path to the on-disk database file.
SERIOUSDB_LOG_LEVEL INFO Logging level (DEBUG/INFO/WARNING/ERROR/CRITICAL).
SERIOUSDB_HOST 127.0.0.1 Host IP where the API is running.
SERIOUSDB_PORT 8000 Host port which is used by the API.

Documentation

License

This project is licensed under the MIT License.

About

A simple, yet effective persistent key-value database.

Resources

Code of conduct

Contributing

Security policy

Stars

224 stars

Watchers

8 watching

Forks

Releases

Packages

Contributors

Languages