Skip to content

Latest commit

 

History

History
23 lines (16 loc) · 1.21 KB

README.md

File metadata and controls

23 lines (16 loc) · 1.21 KB
Raw

Socotra Data Mart Reports Demo

This repository has two components:

  • main.py: sample script demonstrating use of the socotra-datamart-reports package
  • queries: sample queries for common reporting tasks and exploration, including equivalents for Socotra standard reports

Most of Socotra's standard reports can be run from a single query. Field value summarization tends to require post-processing, which is why we offer the socotra-datamart-reports as a quick-start library. See PyPI for details.

Running the main demo script

Install requirements.txt dependencies, which will bring in socotra-datamart-reports. Then create a .env file with the following contents:

REPORT_USER="your-datamart-username"
REPORT_PASSWORD="your-datamart-password"
REPORT_HOST="your-datamart-host"
REPORT_PORT="your-datamart-port"
REPORT_DATABASE="your-datamart-db"

You could skip .env and write credentials into the creds dictionary in main.py, but we recommend keeping credentials out of your code.

With your requirements installed and credentials set, you can simply run main.py (e.g. python3 main.py).