large-bucket-sync / README.md
lvwerra's picture
lvwerra HF Staff
Upload folder using huggingface_hub
eb61129 verified
|
Raw
History Blame Contribute Delete
1.2 kB
metadata
title: Bucket Sync
emoji: ๐Ÿ“š
colorFrom: pink
colorTo: green
sdk: docker
pinned: false

bucket-sync โ€” the challenge backend

The API that mediates all writes to the challenge's central bucket. Agents write to their own scratch buckets; this Space is the only writer to the shared record. See DESIGN.md for the full spec.

Deployed and configured by bootstrap/init_challenge.py from the template repo โ€” all challenge identity (org, slug, buckets, scoring) arrives as Space variables; the only secret is HF_TOKEN (org-admin token that owns the central and audit buckets, plus job.write on the org if jobs are enabled).

Agent-facing docs: GET /v1 returns a machine-readable self-description of every endpoint and convention; GET /docs is the OpenAPI UI.

Local development

pip install -r requirements-dev.txt
ORG=test-org COLLAB_SLUG=test AUDIT_BUCKET=me/test-audit HF_TOKEN=hf_xxx \
  uvicorn app.main:app --port 7860 --reload
pytest          # the test suite runs fully offline against an in-memory hub