Skip to content

Commit 7891bfb

Browse files
committed
fix(ci): point sibling-checkout at Seungpyo1007/TechAPI and drop PokeAPI mentions
CI was failing on every workflow because the sibling-data checkout pointed at GetTechAPI/TechAPI, which does not exist — the dataset repo lives at Seungpyo1007/TechAPI. Bulk-rename across the four workflows (test, refresh-data, deploy-pages, coverage-report, validate-data), pyproject Data URL, the README, and the site landing page. Also strips the now-decided-against PokeAPI inspiration references from README, app/dump.py docstring, app/main.py API description, refresh-data header comment, DATA_PIPELINE / DEVELOPMENT / SPEC docs.
1 parent 1158f4a commit 7891bfb

13 files changed

Lines changed: 45 additions & 54 deletions

File tree

.github/workflows/coverage-report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919

2020
- uses: actions/checkout@v4
2121
with:
22-
repository: GetTechAPI/TechAPI
22+
repository: Seungpyo1007/TechAPI
2323
path: TechAPI
2424

2525
- uses: actions/setup-python@v5
@@ -47,7 +47,7 @@ jobs:
4747
- name: Sync sticky coverage issue
4848
env:
4949
GH_TOKEN: ${{ secrets.TECHAPI_PR_TOKEN || secrets.GITHUB_TOKEN }}
50-
TARGET_REPO: ${{ secrets.TECHAPI_PR_TOKEN && 'GetTechAPI/TechAPI' || github.repository }}
50+
TARGET_REPO: ${{ secrets.TECHAPI_PR_TOKEN && 'Seungpyo1007/TechAPI' || github.repository }}
5151
run: |
5252
set -euo pipefail
5353
TITLE="Coverage gaps (auto-generated)"

.github/workflows/deploy-pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626

2727
- uses: actions/checkout@v4
2828
with:
29-
repository: GetTechAPI/TechAPI
29+
repository: Seungpyo1007/TechAPI
3030
path: TechAPI
3131

3232
- uses: actions/setup-python@v5

.github/workflows/refresh-data.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: refresh-data
22

3-
# Static-dump refresh (PokeAPI api-data style + git-scraping pattern).
3+
# Static-dump refresh (git-scraping pattern).
44
# Pulls the latest TechAPI data, validates, regenerates dump/.
55
# - weekly schedule keeps the static dump fresh
66
# - manual trigger for on-demand rebuilds
@@ -24,7 +24,7 @@ jobs:
2424

2525
- uses: actions/checkout@v4
2626
with:
27-
repository: GetTechAPI/TechAPI
27+
repository: Seungpyo1007/TechAPI
2828
path: TechAPI
2929

3030
- uses: actions/setup-python@v5

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313

1414
- uses: actions/checkout@v4
1515
with:
16-
repository: GetTechAPI/TechAPI
16+
repository: Seungpyo1007/TechAPI
1717
path: TechAPI
1818

1919
- uses: actions/setup-python@v5

.github/workflows/validate-data.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
- uses: actions/checkout@v4
2525
- uses: actions/checkout@v4
2626
with:
27-
repository: GetTechAPI/TechAPI
27+
repository: Seungpyo1007/TechAPI
2828
ref: ${{ inputs.data-ref }}
2929
path: TechAPI
3030
- uses: actions/setup-python@v5

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# TechEngine
22

3-
> **Validation, ingestion, and serving engine for the [TechAPI](https://github.com/GetTechAPI/TechAPI) dataset.**
3+
> **Validation, ingestion, and serving engine for the [TechAPI](https://github.com/Seungpyo1007/TechAPI) dataset.**
44
55
[![test](https://github.com/GetTechAPI/TechEngine/actions/workflows/test.yml/badge.svg)](https://github.com/GetTechAPI/TechEngine/actions/workflows/test.yml)
6-
 Code: **MIT** · Data: lives in **[TechAPI](https://github.com/GetTechAPI/TechAPI)** (CC-BY-SA 4.0)
6+
 Code: **MIT** · Data: lives in **[TechAPI](https://github.com/Seungpyo1007/TechAPI)** (CC-BY-SA 4.0)
77

88
TechEngine owns everything *around* the data: schema validation, the FastAPI
9-
read API, the PokeAPI-style static JSON dump, the engine's own landing site,
10-
and (next up) automated coverage checks and a weekly ingestion crawler.
9+
read API, the static JSON dump generator, the engine's own landing site, and
10+
(next up) automated coverage checks and a weekly ingestion crawler.
1111

1212
The dataset and the public-facing playground site live in
13-
[TechAPI](https://github.com/GetTechAPI/TechAPI) so each can be versioned,
13+
[TechAPI](https://github.com/Seungpyo1007/TechAPI) so each can be versioned,
1414
mirrored, and licensed independently. The site shipped in this repo is the
1515
engine's own landing — what TechEngine is, what it runs, link out to docs.
1616

@@ -20,7 +20,7 @@ engine's own landing — what TechEngine is, what it runs, link out to docs.
2020
app/
2121
├ validate.py # schema/range/uniqueness checks
2222
├ seed.py # data/ → SQLModel database
23-
├ dump.py # API → static JSON tree (PokeAPI-style)
23+
├ dump.py # API → static JSON tree
2424
├ main.py # FastAPI entrypoint
2525
├ models/ # SQLModel tables
2626
├ routers/ # /v1/{brands,socs,smartphones,gpus,cpus}
@@ -53,7 +53,7 @@ location can be overridden via `TECHAPI_DATA_DIR`; the default looks for
5353
## Quickstart
5454

5555
```bash
56-
git clone https://github.com/GetTechAPI/TechAPI.git ../TechAPI # data source
56+
git clone https://github.com/Seungpyo1007/TechAPI.git ../TechAPI # data source
5757
pip install -e ".[dev]"
5858
python -m app.validate # check data integrity
5959
python -m app.seed # data/ → ./techapi.db (SQLite)

app/dump.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Generate a static JSON dump from the database (§4.2 data flow, §16.1 dump-data.yml).
22
3-
PokeAPI-style: the live API responses are written to a tree of static files so a
4-
client can fetch ``dump/v1/smartphones/galaxy-s25/index.json`` without any server.
5-
Because the dump is produced by replaying the real endpoints through an in-process
3+
The live API responses are written to a tree of static files so a client can
4+
fetch ``dump/v1/smartphones/galaxy-s25/index.json`` without any server. Because
5+
the dump is produced by replaying the real endpoints through an in-process
66
client, the static files byte-match the live API — zero serialization drift.
77
88
Run with: ``python -m app.dump`` (writes to ``./dump`` by default).

app/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
DESCRIPTION = (
2222
"Open data platform for consumer electronics specs. "
23-
"Free, open-source, and inspired by PokeAPI. "
23+
"Free and open-source. "
2424
f"Data licensed CC-BY-SA 4.0. Try `GET {PREFIX}/smartphones`."
2525
)
2626

docs/DATA_PIPELINE.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,6 @@ daily) refresh is plenty. That makes a pre-generated static dataset ideal:
1818
- **Fast**: edge-cached files, no cold starts.
1919

2020
### How others do it
21-
- **PokeAPI** converted its API to **static JSON files** in 2018, generated
22-
from its database by an updater bot and hosted on cheap static hosting +
23-
Cloudflare CDN. See [PokeAPI/api-data](https://github.com/PokeAPI/api-data),
24-
[pokeapi.co/about](https://pokeapi.co/about).
2521
- **Git scraping** (Simon Willison): a scheduled GitHub Actions job fetches
2622
data, pretty-prints it, and commits it back when it changes — no server
2723
needed. See [simonwillison.net](https://simonwillison.net/2020/Oct/9/git-scraping/).
@@ -80,7 +76,7 @@ real option but is a **strategy change**, so here are the paths:
8076

8177
| Option | What it means | Trade-offs |
8278
|---|---|---|
83-
| **A. Public (current SPEC)** | `data/` + static dump public, CC-BY-SA | Simplest; matches open-data mission & PokeAPI model; community can contribute & self-host. Anyone can copy the data. |
79+
| **A. Public (current SPEC)** | `data/` + static dump public, CC-BY-SA | Simplest; matches open-data mission; community can contribute & self-host. Anyone can copy the data. |
8480
| **B. Private factory → public product** | Scrapers + raw/messy data in a **private** repo; only a curated, licensed **public dump** is published | Best of both: keep collection methods/raw data private, still ship an open API. Two repos to run. |
8581
| **C. Fully private** | Data + dump + API all private (private repo, auth-gated API) | Maximum control / proprietary value, but abandons the open-data positioning, CC-BY-SA, and community contributions. The API stays code-MIT but data is closed. |
8682

docs/DEVELOPMENT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## What this is
77

88
TechAPI — a free, open REST API for consumer-electronics specs (smartphones,
9-
SoCs, GPUs, CPUs, brands). FastAPI + SQLModel, inspired by PokeAPI. **This repo is
9+
SoCs, GPUs, CPUs, brands). FastAPI + SQLModel. **This repo is
1010
the public product: the API + a curated dataset + a static JSON dump.** It does
1111
**not** contain data-collection/scraping tooling (that is maintained separately;
1212
see "Data scope" below).
@@ -57,7 +57,7 @@ data/ CURATED SEED DATA — singular folder names, organised by b
5757
scripts/
5858
seed.py data/ → DB (recurses brand subfolders; coerces ISO dates)
5959
validate.py schema/range/FK/slug checks (run in CI on data changes)
60-
dump.py DB → static JSON dump (replays API; PokeAPI-style) → ./dump
60+
dump.py DB → static JSON dump (replays API in-process) → ./dump
6161
tests/ unit/ + integration/ (conftest seeds a temp SQLite from data/)
6262
docs/ SPEC.md, DATA_PIPELINE.md, DEVELOPMENT.md
6363
.github/workflows/ test.yml, validate-data.yml, refresh-data.yml
@@ -84,8 +84,8 @@ python -m app.dump # generate ./dump/ static tree (gitignored)
8484
recorded as **ADR-011** / **§6.7** in docs/SPEC.md (maintainer wants computer chips).
8585
- **GPU activated** — model existed (§6.5); endpoints + data added.
8686
- **Data restructured** to singular names + brand subfolders (maintainer request).
87-
- **Static-dump pivot**`scripts/dump.py` exports the API to a static JSON tree
88-
(PokeAPI api-data style), refreshed by GitHub Actions (`refresh-data.yml`).
87+
- **Static-dump pivot**`app/dump.py` exports the API to a static JSON tree,
88+
refreshed by GitHub Actions (`refresh-data.yml`).
8989
- **Scoring** is a Phase-0 reference-based approximation; Phase 1 → dataset-wide
9090
min-max (§8.4). Raw third-party benchmarks (Geekbench/AnTuTu/Cinebench/Time Spy)
9191
are stored as algorithm inputs but NOT exposed (ADR-006).

0 commit comments

Comments
 (0)