Fast-API Response catalog for pre-computed query
Project description
Akvo-ResponseGrouper
Fast-API Response catalog for pre-computed query
Install
$ pip install AkvoResponseGrouper
Schema Requirements
Please follow the required schema before using AkvoResponseGrouper.
Usage
- Database Migration
Database migration is the first required step for AkvoResponseGrouper to work. Use the akvo-responsegrouper CLI to migrate all data sources with JSON configuration files to generate Materialized Views that AkvoResponseGrouper can then use.
$ akvo-responsegrouper
usage: akvo-responsegrouper [-h] [-c CONFIG] [-d]
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
akvo-responsegrouper -c <json_file_config>
-d, --drop Drop the ar_category view table
- Router
To get the new endpoint provided by AkvoResponseGrouper, import the collection route to the App by:
from fastapi import FastAPI
from AkvoResponseGrouper.routes import collection_route
app = FastAPI(
root_path="/",
title="Akvo Response Grouper Demo",
)
app.include_router(collection_route)
@app.get("/", tags=["Dev"])
def read_main():
return "OK"
- Query
Development
Run Dev Containers
The dev environment contains two containers: FastAPI backend and PostGres db, to run:
docker compose up -d
Before go to the next step, wait until the service started at http://localhost:5000.
Seed Necessary Data
In order to debug the data itself. We need to seed the example form and fake datapoints
docker compose exec backend python -m script.seeder_form
docker compose exec backend python -m script.seeder_datapoint <number_of_datapoint>
Migration
Dev environment uses contents that is available in Akvo-ResponseGrouper/src/AkvoResponseGrouper
. To create the Category Materialized View via CLI in dev environment:
Upgrade:
python -m AkvoResponseGrouper.cli.migrate -c './sources/category.json'
After upgrade, you can see "AkvoResponseGrouper - Collection" is available in API docs, ussualy http://locahhost:5000/docs (Depends on the root path api).
Downgrade:
python -m AkvoResponseGrouper.cli.migrate -c './sources/category.json'
Teardown
docker compose down -v
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 AkvoResponseGrouper-1.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 930c05e51f39b3dbb696df904fa075232d0f910da5492e74f7d9dd9a08ad50cd |
|
MD5 | 0b8622754c902b5b2a0dc017741e0552 |
|
BLAKE2b-256 | 1b8b9c4a723b119486c521e470a2fc30d8e3d513edcef64b5f559b1c72d8cb76 |
Hashes for AkvoResponseGrouper-1.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c578a4f07874c27332111933d617409ea55670c288a22ad530e030d8e4151ef7 |
|
MD5 | cb63c3ae557a62e495953b740aa8023b |
|
BLAKE2b-256 | 99a49c016c9592df3cc8da201209b2fe8035796ba26b240934e41dc5e8ede8d4 |