# Springless DB Server (sl-dbserver)
This is a simple Python server for the purpose of spinning up and destroying full copies of a
database on demand. An example use-case is running integration tests with a local postgres
instance in a docker container. Each test can create its own isolated database, run its
tests, and then destroy the created database instance when done.
# Requirements
- Python 3.10 or later
- Dependencies specified in `setup.py`
# Installing and running
If you are using this for testing a SQLAlchemy database, install via pip into the same virtual
environment your database is on:
```
pip install sl-dbserver
```
Otherwise create a new virtual environment and install there.
```
python3 -m venv .venv
.venv/bin/python -m pip install --upgrade pip
. .venv/bin/activate
pip install sl-dbserver
```
And then run with Uvicorn, which should be installed as part of the dependencies.
```
uvicorn sl.dbserver.app:main --port 8000
```
You can then access the documentation via the `/doc` or `/redoc` endpoints. So for the example
above, you would go to [http://localhost:8000/doc](http://localhost:8000/doc) or
[http://localhost:8000/redoc](http://localhost:8000/redoc), which will list the available
endpoints and documentation on the data to post to each.
Raw data
{
"_id": null,
"home_page": "https://github.com/Springless/sl-dbserver",
"name": "sl-dbserver",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sl springless database server testing postgresql",
"author": "cogs",
"author_email": "cogs@springless.com",
"download_url": "https://files.pythonhosted.org/packages/06/bf/76aab9e0ca32c732dbc79b1ab80fc9ae237a9089ea74d8ce2449b7701492/sl-dbserver-0.0.0.tar.gz",
"platform": null,
"description": "# Springless DB Server (sl-dbserver)\n\nThis is a simple Python server for the purpose of spinning up and destroying full copies of a\ndatabase on demand. An example use-case is running integration tests with a local postgres\ninstance in a docker container. Each test can create its own isolated database, run its\ntests, and then destroy the created database instance when done.\n\n# Requirements\n\n- Python 3.10 or later\n- Dependencies specified in `setup.py`\n\n# Installing and running\n\nIf you are using this for testing a SQLAlchemy database, install via pip into the same virtual\nenvironment your database is on:\n\n```\npip install sl-dbserver\n```\n\nOtherwise create a new virtual environment and install there.\n\n```\npython3 -m venv .venv\n.venv/bin/python -m pip install --upgrade pip\n. .venv/bin/activate\npip install sl-dbserver\n```\n\nAnd then run with Uvicorn, which should be installed as part of the dependencies.\n\n```\nuvicorn sl.dbserver.app:main --port 8000\n```\n\nYou can then access the documentation via the `/doc` or `/redoc` endpoints. So for the example\nabove, you would go to [http://localhost:8000/doc](http://localhost:8000/doc) or\n[http://localhost:8000/redoc](http://localhost:8000/redoc), which will list the available\nendpoints and documentation on the data to post to each.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Springless Database Server",
"version": "0.0.0",
"split_keywords": [
"sl",
"springless",
"database",
"server",
"testing",
"postgresql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cdbfaa3fc19c519cd8dfe492339f950a67f3564374441917d63aadd6557f9912",
"md5": "96b13f562943099aed607a08f0713898",
"sha256": "fe7fd520f2118726bde5edc3470f7d7282d27efce348fc8c345982b283d2f1c6"
},
"downloads": -1,
"filename": "sl_dbserver-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96b13f562943099aed607a08f0713898",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18785,
"upload_time": "2023-02-08T03:27:05",
"upload_time_iso_8601": "2023-02-08T03:27:05.758049Z",
"url": "https://files.pythonhosted.org/packages/cd/bf/aa3fc19c519cd8dfe492339f950a67f3564374441917d63aadd6557f9912/sl_dbserver-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06bf76aab9e0ca32c732dbc79b1ab80fc9ae237a9089ea74d8ce2449b7701492",
"md5": "1137fa4a48ef06fd4135bf51d3160998",
"sha256": "3f39cba8cee1011beefdc17c44c93f511d5e5c79b6345f5370d53a9011cb4ae4"
},
"downloads": -1,
"filename": "sl-dbserver-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "1137fa4a48ef06fd4135bf51d3160998",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14395,
"upload_time": "2023-02-08T03:27:07",
"upload_time_iso_8601": "2023-02-08T03:27:07.760785Z",
"url": "https://files.pythonhosted.org/packages/06/bf/76aab9e0ca32c732dbc79b1ab80fc9ae237a9089ea74d8ce2449b7701492/sl-dbserver-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 03:27:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Springless",
"github_project": "sl-dbserver",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "sl-dbserver"
}
JSON
