DigitalChild Documentation¶

Back to GRIMdata Home

Welcome to the complete documentation for DigitalChild (LittleRainbowRights), a Python pipeline for analyzing human rights documents with focus on child and LGBTQ+ digital protections.

Quick Links¶

Getting Started

Install and run your first pipeline

Quick Start
REST API

Access data programmatically via 12 endpoints

API Documentation
Scorecard

Explore 10 indicators across 194 countries

Digital Rights Scorecard
Help & Support

Common questions and troubleshooting

FAQ

Documentation Sections¶

Getting Started¶

Installation - Set up DigitalChild on your system
Quick Start - Run your first pipeline in 5 minutes
First Run Errors - Troubleshooting guide

Core Guides¶

Runbook - Complete pipeline operations guide
Scorecard Workflow - Country indicator system
Production Deployment - Deploy the API in production

API Documentation¶

API Overview - REST API features and quickstart
API Reference - All 12 endpoints with examples
API Quick Reference - Endpoint cheat sheet

Scorecard¶

Scorecard Overview - What it tracks and why
Design & Methodology - How indicators are defined
Data Access - API, CSV, and file access
Visualization - Interactive map, indicator & regional charts
Data Explorer - Filter, search, sort & compare countries

Transparency Watch¶

Source Transparency Watch - When peer organisations adopt open-data transparency

Standards & Specifications¶

Metadata Schema - Document metadata structure
Tags Config Format - Tagging system format
Scraper Structure - How to build scrapers
File Naming Standards - Naming conventions

Technical Architecture¶

Architecture - System design overview
Roadmap - Development phases and progress

Project Information¶

FAQ - Frequently asked questions
Contributing - How to contribute
License - MIT License

Project Structure¶

DigitalChild/
├── pipeline_runner.py      # Main entry point
├── scrapers/               # Web scrapers for document sources
├── processors/             # Text extraction and tagging
├── api/                    # Flask REST API (Phase 4)
├── data/
│   ├── raw/               # Downloaded documents
│   ├── processed/         # Extracted text
│   ├── metadata/          # Document metadata with tags
│   └── exports/           # CSV exports for analysis
├── configs/               # Tag configurations and URL dictionaries
├── docs/                  # This documentation
└── tests/                 # Test suite (347 tests)

Key Features¶

Document Pipeline: Scrape → Process → Tag → Enrich → Export
REST API: 12 self-hosted API endpoints with authentication and rate limiting
Scorecard System: 10 indicators × 194 countries for digital rights analysis
Flexible Tagging: Regex-based tagging with version control
Data Quality: Source extraction and link checks; the canonical workbook currently exports 2,581 source links
Open Source: MIT license for code, CC BY 4.0 for data

Technical guidance¶

Documentation · First-run troubleshooting · FAQ · Data governance

Citation¶

@software{digitalchild2025,
  title = {DigitalChild: Human Rights Data Pipeline for Child and LGBTQ+ Digital Protection},
  author = {Vollmer, S.C. and Vollmer, D.T.},
  year = {2026},
  version = {2.1.0},
  doi = {10.5281/zenodo.20950631},
  url = {https://github.com/MissCrispenCakes/DigitalChild},
  note = {Available at https://grimdata.org. ORCID: 0000-0002-3359-2810 (S.C. Vollmer), 0000-0002-5035-3395 (D.T. Vollmer)}
}

Version: 2.1.0 · Release DOI · Software series DOI Last Updated: June 2026 License: MIT (code) / CC BY 4.0 (data)