Skip to content

About

The Open Checklist Project is an open-data initiative to standardize and share trading card checklist data for collectors, developers, and the broader hobby ecosystem.

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Open Checklist Project

Validate Data

The Open Checklist Project is an open-data initiative to standardize and share trading card checklist data for collectors, developers, and the broader hobby ecosystem.

Goals

  • Make reliable, structured checklist data freely available
  • Define open schemas for consistent use across tools and apps
  • Foster a contributor-friendly ecosystem for managing and improving trading card data

Contents

  • ✅ Open YAML schemas — sets, manifests, and checklists (the v0.3 manifest form)
  • 📦 Curated and contributed checklist data (organized by genre, sport, and set)
  • 🛠 Tools for validating, transforming, and consuming data
  • 🤝 GitHub workflows for contributor validation

Schemas

The project uses standardized, independently-versioned schemas. As of v0.3, a set is stored in the manifest form — a compact set.yaml + manifest.yaml + checklists/ from which the full per-card explosion is derived — replacing the older one-file-per-card layout.

For the manifest form, the identity/UUID contract, versioning, validation, and examples, see the schemas directory.

Validation

To validate your data against the schemas, you can use Docker:

# Build the validation container
docker build -t open-checklist-validator .

# Run validation on all data files
docker run open-checklist-validator

Alternatively, if you have Python 3.11+ installed:

pip install pyyaml jsonschema
python tools/validate.py

PRs touching data/ also get an advisory computed review report; run it locally with python tools/review_report.py data/<genre>/<set-id> (see CONTRIBUTING.md).

Learn More

License

Open data is licensed under Creative Commons (TBD). Schema and code under MIT.

About

The Open Checklist Project is an open-data initiative to standardize and share trading card checklist data for collectors, developers, and the broader hobby ecosystem.

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages