Metadata-Version: 2.1
Name: AkvoResponseGrouper
Version: 1.0.0
Summary: Fast-API Response catalog for pre-computed query
Home-page: https://github.com/akvo/Akvo-ResponseGrouper
Author: Akvo
Author-email: tech.consultancy@akvo.org
Project-URL: Documentation, https://github.com/akvo/Akvo-ResponseGrouper
Project-URL: Bug Reports, https://github.com/akvo/Akvo-ResponseGrouper/issues
Project-URL: Source Code, https://github.com/akvo/Akvo-ResponseGrouper
Keywords: akvo,data,helper,pypi,package
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Database :: Database Engines/Servers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Framework :: FastAPI
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8.5
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic
Requires-Dist: sqlalchemy
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'

# Akvo-ResponseGrouper
Fast-API Response catalog for pre-computed query

## Install
```
$ pip install AkvoResponseGrouper
```

## Schema Requirements

Please follow [the required schema](https://github.com/akvo/Akvo-ResponseGrouper/blob/main/docs/database.org) before using AkvoResponseGrouper.

## Usage

1. 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.

```bash
$ 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
```

2. HTTP Router

Soon...

## Development

```bash
cd dev
docker compose up -d
```
Wait until migration process is done

```bash
docker compose exec backend python -m script.seeder_form
docker compose exec backend python -m script.seeder_datapoint <number_of_datapoint>
```
