Declarative, instant REST APIs for base AI Models based on instarest, a FastAPI, Pydantic, SQLAlchemy, and PostgreSQL library.
Project description
Getting Started Locally
-
Launch postgres and pgadmin via docker-compose
docker-compose up --build
. -
Keeping your containers running, open a new terminal with the root of this repo as the working directory. Install
poetry
:pip install poetry
(or usepipx
on link here if you prefer isolated envs, or consider usingconda
). -
Create and enter the virtual environment:
poetry shell
-
Install the dependencies
poetry install
-
Start the app:
uvicorn examples.example_app:auto_app --reload
. -
Open
localhost:8000/v1/docs
and start interacting with swagger! -
You can shut down and your db / minio data will persist via docker volumes.
MinIO
- The MinIO console is available at
localhost:9001
. Login with user:miniouser
and password:minioadmin
if you launched the containers withdocker-compose up --build
.
Contibuting
-
Set up the precommit hook with
pre-commit install
. -
Run tests and get coverage with
pytest --cov
, and get html reports for vs code live server (or any server) withpytest --cov --cov-report=html:coverage_re
-
Open a pull request against the repo! Please write tests, your coverage will automatically be added as a comment to any PR via GH actions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aimbase-0.0.3a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23a54d8848a2fca12cb269e3de4aa918a8a0926aa0b9dfd8b4a33fbbae326fad |
|
MD5 | dd6a3cf0c1d82d9b014cb3c67656df14 |
|
BLAKE2b-256 | 6122c07db2e1c66fc10eca6a4875046d2cf12bfb531fe8a98ac9fde00098fd3c |