skypydb 0.1.2

Open-source Reactive Python database

Skypy - open-source reactive database.
The better way to build Python logging system!

| | Docs

pip install skypydb # python client
# or download from the source
# git clone https://github.com/Ahen-Studio/skypy-db.git
# cd skypy-db
# pip install -r requirements.txt

Features

• Simple: fully-documented

• Table: create, update, delete data from a table

• Observable: Dashboard with real-time data, metrics, and query inspection

• Free & Open Source: MIT Licensed

TODO

• code the database backend
• Create the dashboard using Reflex
• write the documentation
• improve user data security
• code a custom cli

What's next!

• give us ideas!

API

• use the api with a custom config

import skypydb

# setup skypydb client.
client = skypydb.Client(path="./data/skypy.db")

# config to make custom table.
config = {
    "all-my-documents": {
        "title": "str",
        "user_id": str,
        "content": str,
        "id": "auto"
    },
    "all-my-documents1": {
        "title": "str",
        "user_id": str,
        "content": str,
        "id": "auto"
    },
    "all-my-documents2": {
        "title": "str",
        "user_id": str,
        "content": str,
        "id": "auto"
    },
}

# Create tables. get_table_from_config(config, table_name="all-my-documents"), delete_table_from_config(config, table_name="all-my-documents") are also available.
try:
    table = client.create_table_from_config(config)# Create all the tables present in the config.
except Exception:
    # Tables already exist, that's fine
    pass

# Retrieve the table before adding any data.
table = client.get_table_from_config(config, table_name="all-my-documents")

# Add data to a table.
table.add(
    title=["document"],
    user_id=["user123"],
    content=["this is a document"],
    id=["auto"]# ids are automatically created by the backend.
)

# Keep the program running so the dashboard stays active
client.wait()

• use the api without a custom config

import skypydb

# setup skypydb client.
client = skypydb.Client(path="./data/skypy.db")

# Create table. get_table, delete_table are also available.
try:
    table = client.create_table("all-my-documents")
except Exception:
    # Tables already exist, that's fine
    pass

# Retrieve the table before adding any data.
table = client.get_table("all-my-documents")

# Add data to the table.
table.add(
    title=["document"],
    user_id=["user123"],
    content=["this is a document"],
    id=["auto"]# ids are automatically created by the backend
)

# Keep the program running so the dashboard stays active
client.wait()

Dashboard

The dashboard starts automatically when you create a client. To keep it running after your operations:

import skypydb

client = skypydb.Client(path="./data/skypy.db")

# ... your operations here ...

# Keep the dashboard active
client.wait()  # Dashboard accessible at http://127.0.0.1:3000

Dashboard options:

# Change the dashboard port
client = skypydb.Client(
    path="./data/skypy.db",
    dashboard_port=8080
)

# Disable auto-start
client = skypydb.Client(
    path="./data/skypy.db",
    auto_start_dashboard=False
)

# Start manually later
client.start_dashboard()

Learn more on our Docs

License

MIT