storyteller-dhs 0.1.3

Storyteller-DHS: Explore and analyze DHS (Demographic and Health Surveys) datasets with an intuitive interface and CLI tools.

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
2. Features
3. Installation
4. Usage
5. Development
6. Deploying to PyPI
7. Contributing
8. License
9. 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 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

Option 1: Install from PyPI (recommended)

You can install the latest stable release directly from PyPI:

pip install storyteller-dhs

Option 2: Install from source

Clone the repository and install in editable mode:

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:

storyteller start "path/to/your/dhs-database.db"

Other commands:

• Enable FTS manually:

  enable_fts --db_path="path/to/your/dhs-database.db"
  

• Run predefined queries:

  storyteller query "path/to/your/dhs-database.db" --menu=mintiloai
  

---

Development

To build the package (wheel + sdist):

python -m build

To run the development build process with additional checks:

build_package.bat

---

Deploying to PyPI

These are the steps to publish a new release of Storyteller to PyPI:

1. Update version
   Bump the version in _version.py and update CHANGELOG.md.

2. Build the package
   Run:

   python -m build
   

   This creates .whl and .tar.gz files inside the dist/ folder.

3. Install Twine (if not installed)

   pip install twine
   

4. Upload to Test PyPI (optional)

   twine upload --repository-url https://test.pypi.org/legacy/ dist/*
   

   Verify the package works by installing from Test PyPI.

5. Upload to PyPI (production)

   twine upload dist/*
   

6. Verify release
   Visit PyPI Project Page and confirm your release.

---

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 file for details.

---

Contact

kofiyatech
Email: [e-mail]
Website: https://kofiyatech.com