dbstudio

Name	dbstudio JSON
Version	0.1.1 JSON
	download
home_page	None
Summary	Web-based database management tool.
upload_time	2024-09-10 12:06:35
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	MIT
keywords	python db sqlalchemy sqlmodel web-ui fastapi starlette pydantic
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # DB Studio

A web-based database management tool that allows you to manage your databases, tables, and data.

It is designed to be embedded into your Python web applications, is currently compatible with FastAPI,
Starlette, SQLAlchemy and SQLModel.

## Get started

Install DB Studio from PyPI using pip or your favorite package manager:

```sh
pip install dbstudio
```

After configuring DB Studio, the UI will be available at `http://<your-server>/dbstudio`.

## FastAPI

```python
from fastapi import FastAPI
from dbstudio.fastapi import get_fastapi_router

# Be sure to import your DB models before initializing DBStudio
import .models

app = FastAPI()

# The router must be mounted at /dbstudio
app.mount("/dbstudio", get_fastapi_router(engine))
```

## Starlette

```python
from starlette.applications import Starlette
from dbstudio.starlette import get_startlette_mount

# Be sure to import your DB models before initializing DBStudio
import .models

app = Starlette(
    routes=[get_startlette_mount(engine)],
)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dbstudio",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "python, db, sqlalchemy, sqlmodel, web-ui, fastapi, starlette, pydantic",
    "author": null,
    "author_email": "Luca Faggianelli <luca@velvetlab.tech>",
    "download_url": "https://files.pythonhosted.org/packages/bc/c8/e0916602f73db02997c020a69bffc54cfb302221ffd42a1c718bf31a42b4/dbstudio-0.1.1.tar.gz",
    "platform": null,
    "description": "# DB Studio\n\nA web-based database management tool that allows you to manage your databases, tables, and data.\n\nIt is designed to be embedded into your Python web applications, is currently compatible with FastAPI,\nStarlette, SQLAlchemy and SQLModel.\n\n## Get started\n\nInstall DB Studio from PyPI using pip or your favorite package manager:\n\n```sh\npip install dbstudio\n```\n\nAfter configuring DB Studio, the UI will be available at `http://<your-server>/dbstudio`.\n\n## FastAPI\n\n```python\nfrom fastapi import FastAPI\nfrom dbstudio.fastapi import get_fastapi_router\n\n# Be sure to import your DB models before initializing DBStudio\nimport .models\n\napp = FastAPI()\n\n# The router must be mounted at /dbstudio\napp.mount(\"/dbstudio\", get_fastapi_router(engine))\n```\n\n## Starlette\n\n```python\nfrom starlette.applications import Starlette\nfrom dbstudio.starlette import get_startlette_mount\n\n# Be sure to import your DB models before initializing DBStudio\nimport .models\n\napp = Starlette(\n    routes=[get_startlette_mount(engine)],\n)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Web-based database management tool.",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [
        "python",
        " db",
        " sqlalchemy",
        " sqlmodel",
        " web-ui",
        " fastapi",
        " starlette",
        " pydantic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3044b49b14ebb72e9b01ec2c327203a8f79794fef50e84febf7d437fd2e9c024",
                "md5": "0b76c4bfcb8aaf726721689417d4d632",
                "sha256": "51c17f05d757985ed807171a7fdc7132b5483bb6cb622e54ae3bb3fac98a39f7"
            },
            "downloads": -1,
            "filename": "dbstudio-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0b76c4bfcb8aaf726721689417d4d632",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 112904,
            "upload_time": "2024-09-10T12:06:34",
            "upload_time_iso_8601": "2024-09-10T12:06:34.294478Z",
            "url": "https://files.pythonhosted.org/packages/30/44/b49b14ebb72e9b01ec2c327203a8f79794fef50e84febf7d437fd2e9c024/dbstudio-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bcc8e0916602f73db02997c020a69bffc54cfb302221ffd42a1c718bf31a42b4",
                "md5": "e42fa6e18df633abc32c708cbda8b09b",
                "sha256": "952804e17e97b20ed5490955bb4b486f14c548f5774defa225e3e1c76939cb64"
            },
            "downloads": -1,
            "filename": "dbstudio-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e42fa6e18df633abc32c708cbda8b09b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 112568,
            "upload_time": "2024-09-10T12:06:35",
            "upload_time_iso_8601": "2024-09-10T12:06:35.779251Z",
            "url": "https://files.pythonhosted.org/packages/bc/c8/e0916602f73db02997c020a69bffc54cfb302221ffd42a1c718bf31a42b4/dbstudio-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-10 12:06:35",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "dbstudio"
}