Skip to content

README.md

Latest commit

 

History

History
50 lines (35 loc) · 2.12 KB

README.md

File metadata and controls

50 lines (35 loc) · 2.12 KB
Raw

TechAPI

Curated, open dataset for consumer electronics specs. Free, share-alike, machine-readable.

validate-data  Data: CC-BY-SA 4.0

This repo holds the curated dataset and the public site (Astro intro + playground). The API server, ingestion crawlers, coverage checks, and the static-dump generator live in TechEngine.

Layout

data/brand/<country>/<slug>.json                       # e.g. data/brand/kr/samsung.json
data/soc/<manufacturer>/<year>/<slug>.json             # data/soc/qualcomm/2024/snapdragon-8-elite.json
data/smartphone/<brand>/<year>/<slug>.json             # data/smartphone/samsung/2025/galaxy-s25.json
data/gpu/<manufacturer>/<year>/<segment>/<slug>.json   # data/gpu/nvidia/2025/consumer/geforce-rtx-5090.json
data/cpu/<manufacturer>/<year>/<segment>/<slug>.json   # data/cpu/intel/2023/consumer/core-i9-14900k.json

All paths use singular folder names. Slugs are kebab-case and unique within each category.

The Astro site lives under site/ and is the deploy target for GitHub Pages. It consumes the static JSON dump produced by TechEngine's weekly-refresh workflow.

Self-Check

A lightweight bundled validator lives at app/validate.py. It runs on every PR via validate-data.yml and is also chained into the heavier TechEngine validation workflow as a downstream job.

python -m app.validate

The validator uses only the Python standard library; no install step required.

Contributing

Open a PR with the new/updated JSON file. The PR template walks through what to include. The validator must pass. All records (brand, soc, smartphone, gpu, and cpu) must include source_urls with at least one canonical reference (vendor product page, Wikipedia infobox, datasheet).

License

Data is licensed CC-BY-SA 4.0; attribute "Data from TechAPI" and share alike. The bundled validator code is MIT.