# Auto-REST
A light-weight CLI tool for deploying dynamically generated REST APIs against relational databases.
See the [project documentation](https://better-hpc.github.io/auto-rest/) for detailed usage instructions.
## Supported Databases
Auto-REST provides built-in support for the database types listed below.
Support for additional databases can be added by installing the corresponding database drivers.
See the official documentation for instructions.
| Flag | Default Driver | Database Type |
|------------|------------------------------|----------------------|
| `--sqlite` | `sqlite+aiosqlite` | SQLite |
| `--psql` | `postgresql+asyncpg` | PostgreSQL |
| `--mysql` | `mysql+asyncmy` | MySQL |
| `--oracle` | `oracle+oracledb` | Oracle |
| `--mssql` | `mssql+aiomysql` | Microsoft SQL Server |
| `--driver` | Custom driver (user-defined) | Custom |
## Quickstart
Install the command line utility using your favorite Python package manager.
```shell
pipx install auto-rest-api
```
Check the package installed correctly.
```shell
auto-rest --help
```
Launch an API by providing connection arguments to a database of your choice.
```shell
auto-rest \
--psql
--db-host localhost
--db-port 5432
--db-name default
--db-user jsmith
--db-password secure123!
```
Navigate `localhost:8081/docs/` to view the OpenAPI documentation for your dynamically generated REST API!
Raw data
{
"_id": null,
"home_page": null,
"name": "auto-rest-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.11",
"maintainer_email": null,
"keywords": "Better, HPC, automatic, rest, api",
"author": "Better HPC LLC",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/76/80/a6cb5b85acf7c49943510e24fb1b2574e1ac779b0b0c670b8a79461d6e60/auto_rest_api-0.1.10.tar.gz",
"platform": null,
"description": "# Auto-REST\n\nA light-weight CLI tool for deploying dynamically generated REST APIs against relational databases.\nSee the [project documentation](https://better-hpc.github.io/auto-rest/) for detailed usage instructions.\n\n## Supported Databases\n\nAuto-REST provides built-in support for the database types listed below.\nSupport for additional databases can be added by installing the corresponding database drivers.\nSee the official documentation for instructions.\n\n| Flag | Default Driver | Database Type |\n|------------|------------------------------|----------------------|\n| `--sqlite` | `sqlite+aiosqlite` | SQLite |\n| `--psql` | `postgresql+asyncpg` | PostgreSQL |\n| `--mysql` | `mysql+asyncmy` | MySQL |\n| `--oracle` | `oracle+oracledb` | Oracle |\n| `--mssql` | `mssql+aiomysql` | Microsoft SQL Server |\n| `--driver` | Custom driver (user-defined) | Custom |\n\n## Quickstart\n\nInstall the command line utility using your favorite Python package manager.\n\n```shell\npipx install auto-rest-api\n```\n\nCheck the package installed correctly.\n\n```shell\nauto-rest --help\n```\n\nLaunch an API by providing connection arguments to a database of your choice.\n\n```shell\nauto-rest \\\n --psql \n --db-host localhost\n --db-port 5432\n --db-name default\n --db-user jsmith\n --db-password secure123!\n```\n\nNavigate `localhost:8081/docs/` to view the OpenAPI documentation for your dynamically generated REST API!\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Automatically map database schemas and deploy per-table REST API endpoints.",
"version": "0.1.10",
"project_urls": null,
"split_keywords": [
"better",
" hpc",
" automatic",
" rest",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9d997e8a136bc295594d8d705a159abbbb56b693265d4035490b48eb61e31e7e",
"md5": "bf1c8206f17d52c3522f9b8b43b49ecf",
"sha256": "af8fe832c85e27349f76b11ff2d5544f50b869c9b93ff625df8f06fecba58151"
},
"downloads": -1,
"filename": "auto_rest_api-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf1c8206f17d52c3522f9b8b43b49ecf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.11",
"size": 28963,
"upload_time": "2025-10-28T13:36:51",
"upload_time_iso_8601": "2025-10-28T13:36:51.387190Z",
"url": "https://files.pythonhosted.org/packages/9d/99/7e8a136bc295594d8d705a159abbbb56b693265d4035490b48eb61e31e7e/auto_rest_api-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7680a6cb5b85acf7c49943510e24fb1b2574e1ac779b0b0c670b8a79461d6e60",
"md5": "3a6ac917f75eea3492be33c5b617a7e5",
"sha256": "e21cf2d703a1fff9f58392c40a3aedb1b0ff24b12e249686291490ec2681c7bd"
},
"downloads": -1,
"filename": "auto_rest_api-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "3a6ac917f75eea3492be33c5b617a7e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.11",
"size": 25181,
"upload_time": "2025-10-28T13:36:52",
"upload_time_iso_8601": "2025-10-28T13:36:52.258351Z",
"url": "https://files.pythonhosted.org/packages/76/80/a6cb5b85acf7c49943510e24fb1b2574e1ac779b0b0c670b8a79461d6e60/auto_rest_api-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-28 13:36:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "auto-rest-api"
}
JSON