Auto-REST
A light-weight CLI tool for deploying dynamically generated REST APIs against relational databases. See the project documentation 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.
| CLI 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 CLI using your preferred Python package manager:
pipx install auto-rest-api
Verify that the installation completed successfully:
auto-rest --help
Launch an API by supplying connection parameters for your target database:
auto-rest \
--psql
--db-host localhost
--db-port 5432
--db-name default
--db-user jsmith
--db-password secure123!
Navigate to localhost:8081/docs/ and view the OpenAPI documentation for your dynamically generated REST API!
2 maintainers
Metadata
2 maintainers
Release files for auto-rest-api 0.1.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| auto_rest_api-0.1.12.tar.gz | 24.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| auto_rest_api-0.1.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.6 kB
Release files / auto_rest_api-0.1.12.tar.gz
| Download URL | auto_rest_api-0.1.12.tar.gz |
|---|---|
| Size | 24.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d793382ca921a0b114bd398c39691f0b29c084f00ae01bf7907d277634826c03
|
|
BLAKE2b-256 checksum How to use checksums |
4d892373e7648c0b1a8fdd614645dfb6185751cd2532b4f711d7d0d8eadffe86
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / auto_rest_api-0.1.12-py3-none-any.whl
| Download URL | auto_rest_api-0.1.12-py3-none-any.whl |
|---|---|
| Size | 28.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1573a4e6ca42c83e8da6acafcf06efb6672ebc8d6aca7ea7db4d36c2f261bbfd
|
|
BLAKE2b-256 checksum How to use checksums |
7ef55b827d91693ce43e38e259df63a8b37d0024e452d8747a7285a9aee6904a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for auto-rest-api 0.1.12
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
