docs-quickstart
Open ArchiPy quickstart guidance for app teams
- License 许可
- MIT
- 最近更新
- 2026-11-07
- Stars
- ★ 3
- Forks
- 1
01 前言 Front Matter
- name
- docs-quickstart
- description
- Open ArchiPy quickstart guidance for app teams
- disable-model-invocation
- true
03 SKILL.md 正文
/docs-quickstart
Read ../archipy-docs/SKILL.md in full — use the archipy-docs skill (resolve ../... relative to this skill directory; Claude Code: ${CLAUDE_SKILL_DIR}/../archipy-docs/) — and the Quickstart section of ../archipy-docs/reference.md.
Summarize for the user:
- Python 3.14+ and
uv uv add "archipy[<extras>]"AppConfig(BaseConfig)+set_global- First adapter usage
Live docs: https://syntaxarc.github.io/ArchiPy/getting-started/quickstart/
Offer /scaffold-app if they want files generated, or /scaffold-models for DTOs and errors.
04 同仓库更多 Skills
scaffold-utils
Add or wire pure helpers/utils, preferring ArchiPy utils (datetime, JWT, password, file, string). Use for "add a helper/util function", "format dates", "hash passwords", or "generate tokens".
scaffold-service
Scaffold a thin FastAPI router or gRPC servicer under services/{domain}/v{n}/ with AppUtils bootstrap. Use for "add an endpoint/route/API", "expose via REST/gRPC", or "new API version".
scaffold-observability
Configure ArchiPy 5.x OpenTelemetry traces, metrics, logs, and instrumentation. Use for "add tracing/metrics/OTel", "Prometheus/Pushgateway", or migrating off Sentry, Elastic APM, or old Prometheus.
scaffold-models
Scaffold ArchiPy models under models/: domain/repository DTOs, errors, optional entities and types. Use for "add DTO/schema/request/response model", "new error type", or "SQLAlchemy entity".
scaffold-logic
Scaffold an ArchiPy logic (use case) under logics/{domain}/ with a unit-of-work decorator and DTO I/O. Use for "add business logic", "new use case", "transactional operation", or "service layer method".
scaffold-interceptor
Add or wire cross-cutting FastAPI/gRPC interceptors or middleware, preferring ArchiPy's. Use for "add middleware", "request ID/logging/auth interceptor", or "gRPC interceptor".