Install and Setup¶
The Auto-REST package is published on PyPI.
Installation via pipx is recommended, though the pip utility can also be used.
pipx install auto-rest-api
pip install auto-rest-api
Adding Custom Drivers¶
Auto-REST includes pre-packaged drivers for most common databases. The table below lists the supported database systems along with their default drivers.
| Database System | Default Driver |
|---|---|
| SQLite | sqlite+aiosqlite |
| PostgreSQL | postgresql+asyncpg |
| MySQL | mysql+asyncmy |
| Oracle | oracle+oracledb |
| Microsoft SQL Server | mssql+aiomysql |
Auto-REST is designed to support any database driver compatible with the SQLAlchemy framework. To add support for a new driver, install it in the same environment as the Auto-REST utility.
Important: Driver Support
SQLAlchemy does not enforce minimum feature requirements for database drivers. Some drivers may omit functionality or expose limitations inherent to the underlying DBMS. As a result, specific Auto-REST features may be unavailable when unsupported by the selected driver.
pipx inject auto-rest [PACKAGE_NAME]
pip install [PACKAGE_NAME]