auto-rest-api


Nameauto-rest-api JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryAutomatically map database schemas and deploy per-table REST API endpoints.
upload_time2025-02-04 04:20:31
maintainerNone
docs_urlNone
authorBetter HPC LLC
requires_python>=3.11
licenseGPL-3.0-only
keywords better hpc automatic rest api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Auto-REST

A command line 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 \
  # Enable optional endpoints / functionality
  --enable-docs \
  --enable-write \
  # Define the database type and connection arguments
  --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": ">=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/50/09/00297071b5a7d647ba4cdd52c12338c9b292966d664020741c617a0ac0a1/auto_rest_api-0.1.3.tar.gz",
    "platform": null,
    "description": "# Auto-REST\n\nA command line 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  # Enable optional endpoints / functionality\n  --enable-docs \\\n  --enable-write \\\n  # Define the database type and connection arguments\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.3",
    "project_urls": null,
    "split_keywords": [
        "better",
        " hpc",
        " automatic",
        " rest",
        " api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5484448d0ab3edb71a42636b56879f3c5724cbbe6158b488bff4c2e28f85ca77",
                "md5": "66ae689e16adc3249e869f5a28d53f40",
                "sha256": "c5481625720cc0607f070897627ceeb275d148ca86308d86842bb4c5852b32ec"
            },
            "downloads": -1,
            "filename": "auto_rest_api-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66ae689e16adc3249e869f5a28d53f40",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 28639,
            "upload_time": "2025-02-04T04:20:30",
            "upload_time_iso_8601": "2025-02-04T04:20:30.574244Z",
            "url": "https://files.pythonhosted.org/packages/54/84/448d0ab3edb71a42636b56879f3c5724cbbe6158b488bff4c2e28f85ca77/auto_rest_api-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "500900297071b5a7d647ba4cdd52c12338c9b292966d664020741c617a0ac0a1",
                "md5": "04d49883abfbd42533b1bb6eec04ed74",
                "sha256": "980e617af0d16cc75788ed30fd5c12488c370e9feba9d6be6fc390d865e2adab"
            },
            "downloads": -1,
            "filename": "auto_rest_api-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "04d49883abfbd42533b1bb6eec04ed74",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 24793,
            "upload_time": "2025-02-04T04:20:31",
            "upload_time_iso_8601": "2025-02-04T04:20:31.890670Z",
            "url": "https://files.pythonhosted.org/packages/50/09/00297071b5a7d647ba4cdd52c12338c9b292966d664020741c617a0ac0a1/auto_rest_api-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-04 04:20:31",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "auto-rest-api"
}
        
Elapsed time: 1.32863s