Skip to main content

A plugin of nextline-graphql. A relational database for nextline

Project description

nextline-rdb

PyPI - Version PyPI - Python Version

Test Status Test Status codecov

A plugin for nextline-graphql. A relational database for nextline-graphql.


Table of Contents

Installation

pip install nextline-rdb

Nextline-graphql automatically detects this package as a plugin.

Configuration

Environment variable Default value Description
NEXTLINE_DB__URL sqlite+aiosqlite:// The DB URL of SQLAlchemy

Note: Only tested on SQLite + aiosqlite.

Examples

How to run Nextline-graphql with Nextline RDB

In a virtual environment

Create a virtual environment and install packages.

python -m venv venv
source venv/bin/activate
pip install nextline-graphql
pip install nextline-rdb
pip install uvicorn

Specify the database URL.

export NEXTLINE_DB__URL="sqlite+aiosqlite:///db.sqlite3"

Run on the port 8080.

uvicorn --lifespan on --factory --port 8080 nextlinegraphql:create_app

Check with a web browser at http://localhost:8080/.

In a Docker container

Create a Docker image.

git clone git@github.com:simonsobs/nextline-rdb.git
cd nextline-rdb
docker image build --tag nextline-rdb .

Run on the port 8080 with a file on the host machine db/db.sqlite3 as the persistent DB. The directory db/ and the file db.sqlite3 will be created if they don't exist.

docker run -p 8080:8000 --env NEXTLINE_DB__URL='sqlite+aiosqlite:////db/db.sqlite3' -v "$(pwd)/db:/db" nextline-rdb

Check with a web browser at http://localhost:8080/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nextline_rdb-0.6.9.tar.gz (89.3 kB view hashes)

Uploaded Source

Built Distribution

nextline_rdb-0.6.9-py3-none-any.whl (193.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page