# Storyteller - DHS Database Viewer
Storyteller is a user-friendly web application designed to explore DHS (Demographic and Health Surveys) data.
It provides an intuitive interface for browsing datasets, running queries, and generating insights, making it easier for researchers, analysts, and storytellers to work with complex health and demographic information.
---
## Table of Contents
1. [Overview](#overview)
2. [Features](#features)
3. [Installation](#installation)
4. [Usage](#usage)
5. [Development](#development)
6. [Contributing](#contributing)
7. [License](#license)
8. [Contact](#contact)
---
## Overview
The Storyteller app helps users unlock, search, and explore the full breadth of DHS datasets from any country or year.
It is built on top of [Datasette](https://datasette.io/) and extends it with custom processors, exporters, and metadata tools.
---
## Features
- Browse DHS datasets across household, individual, and biomarker surveys.
- Search across dozens of tables and thousands of records.
- View variable definitions and relationships for every dataset.
- Download filtered data for offline analysis.
- Custom metadata export for reproducibility.
- Simple CLI integration for automation.
---
## Installation
Clone the repository and install the package in editable mode:
```bash
git clone https://github.com/kofiya-technologies/storyteller-DHS-database-viewer
cd storyteller-DHS-database-viewer
pip install pipenv
pipenv install --deploy --ignore-pipfile
```
Dependencies are managed with `setup.py` and `Pipfile`.
---
## Usage
After installation, you can start the Storyteller app:
```bash
storyteller start --db_path="path/to/your/dhs-database.db"
```
Other commands:
- Enable FTS manually:
```bash
enable_fts --db_path="path/to/your/dhs-database.db"
```
- Run predefined queries:
```bash
storyteller query path/to/your/dhs-database.db --menu mintiloai
```
---
## Development
To build the package (wheel + sdist):
```bash
python -m build
```
To run the development build process with additional checks:
```bash
build_package.bat
```
---
## Contributing
We welcome contributions!
Please fork the repository, create a new branch, and submit a pull request.
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
## Contact
**kofiyatech**
Email: kofiya.technologies@gmail.com
Website: [https://kofiyatech.com](https://kofiyatech.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/kofiyatech/storyteller-DHS-database-viewer",
"name": "storyteller-dhs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "dhs, storyteller, datasette, demographics, health, survey, analysis",
"author": "kofiyatech",
"author_email": "kofiya.technologies@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/28/19/66beeb3dbf98f3014f3b8b68f486ccc831290a6b3df0f34ca2f61c678cbc/storyteller_dhs-0.1.1.tar.gz",
"platform": null,
"description": "# Storyteller - DHS Database Viewer\r\n\r\nStoryteller is a user-friendly web application designed to explore DHS (Demographic and Health Surveys) data. \r\nIt provides an intuitive interface for browsing datasets, running queries, and generating insights, making it easier for researchers, analysts, and storytellers to work with complex health and demographic information.\r\n\r\n---\r\n\r\n## Table of Contents\r\n1. [Overview](#overview)\r\n2. [Features](#features)\r\n3. [Installation](#installation)\r\n4. [Usage](#usage)\r\n5. [Development](#development)\r\n6. [Contributing](#contributing)\r\n7. [License](#license)\r\n8. [Contact](#contact)\r\n\r\n---\r\n\r\n## Overview\r\nThe Storyteller app helps users unlock, search, and explore the full breadth of DHS datasets from any country or year. \r\nIt is built on top of [Datasette](https://datasette.io/) and extends it with custom processors, exporters, and metadata tools.\r\n\r\n---\r\n\r\n## Features\r\n- Browse DHS datasets across household, individual, and biomarker surveys. \r\n- Search across dozens of tables and thousands of records. \r\n- View variable definitions and relationships for every dataset. \r\n- Download filtered data for offline analysis. \r\n- Custom metadata export for reproducibility. \r\n- Simple CLI integration for automation. \r\n\r\n---\r\n\r\n## Installation\r\nClone the repository and install the package in editable mode:\r\n\r\n```bash\r\ngit clone https://github.com/kofiya-technologies/storyteller-DHS-database-viewer\r\ncd storyteller-DHS-database-viewer\r\npip install pipenv\r\npipenv install --deploy --ignore-pipfile\r\n```\r\n\r\nDependencies are managed with `setup.py` and `Pipfile`.\r\n\r\n---\r\n\r\n## Usage\r\nAfter installation, you can start the Storyteller app:\r\n\r\n```bash\r\nstoryteller start --db_path=\"path/to/your/dhs-database.db\"\r\n```\r\n\r\nOther commands:\r\n- Enable FTS manually:\r\n ```bash\r\n enable_fts --db_path=\"path/to/your/dhs-database.db\"\r\n ```\r\n- Run predefined queries:\r\n ```bash\r\n storyteller query path/to/your/dhs-database.db --menu mintiloai\r\n ```\r\n\r\n---\r\n\r\n## Development\r\nTo build the package (wheel + sdist):\r\n\r\n```bash\r\npython -m build\r\n```\r\n\r\nTo run the development build process with additional checks:\r\n\r\n```bash\r\nbuild_package.bat\r\n```\r\n\r\n---\r\n\r\n## Contributing\r\nWe welcome contributions! \r\nPlease fork the repository, create a new branch, and submit a pull request.\r\n\r\n---\r\n\r\n## License\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\n## Contact\r\n**kofiyatech** \r\nEmail: kofiya.technologies@gmail.com \r\nWebsite: [https://kofiyatech.com](https://kofiyatech.com)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Storyteller-DHS: Explore and analyze DHS (Demographic and Health Surveys) datasets with an intuitive interface and CLI tools.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/kofiyatech/storyteller-DHS-database-viewer"
},
"split_keywords": [
"dhs",
" storyteller",
" datasette",
" demographics",
" health",
" survey",
" analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "64bcada561647be762bbe3c0fb2ba453ff37091c2b3b0950737e7b4c7d267db6",
"md5": "a8b6d8662dc67bdf0ce9abe7ef728d85",
"sha256": "876839dd6ebde8fdf21d81ecae0a4bf7c4a88ad53e4ee9b8ecbba5985975ef32"
},
"downloads": -1,
"filename": "storyteller_dhs-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8b6d8662dc67bdf0ce9abe7ef728d85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13897,
"upload_time": "2025-09-12T14:49:33",
"upload_time_iso_8601": "2025-09-12T14:49:33.821733Z",
"url": "https://files.pythonhosted.org/packages/64/bc/ada561647be762bbe3c0fb2ba453ff37091c2b3b0950737e7b4c7d267db6/storyteller_dhs-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "281966beeb3dbf98f3014f3b8b68f486ccc831290a6b3df0f34ca2f61c678cbc",
"md5": "d7062784ddd16b5388ee30a1633113b4",
"sha256": "b4e98c787d6f5e91b7b13797dbe4a69b5c5fd39e54996501a78fe248c34d8085"
},
"downloads": -1,
"filename": "storyteller_dhs-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "d7062784ddd16b5388ee30a1633113b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12839,
"upload_time": "2025-09-12T14:49:35",
"upload_time_iso_8601": "2025-09-12T14:49:35.063214Z",
"url": "https://files.pythonhosted.org/packages/28/19/66beeb3dbf98f3014f3b8b68f486ccc831290a6b3df0f34ca2f61c678cbc/storyteller_dhs-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-12 14:49:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kofiyatech",
"github_project": "storyteller-DHS-database-viewer",
"github_not_found": true,
"lcname": "storyteller-dhs"
}
JSON
