Skip to content

Commit 341c32c

Browse files
ulises-jeremiasulises-jeremias
andauthored
docs: document create-python-app ↔ cpa-templates relationship (#144)
Closes #140 Co-authored-by: ulises-jeremias <ulises.jeremias@users.noreply.github.com>
1 parent 7d6f968 commit 341c32c

3 files changed

Lines changed: 50 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,20 @@
99

1010
Composable scaffolding CLI for production-ready Python apps.
1111

12-
> **Status:** bootstrapping complete. Roadmap: [#1](https://github.com/Create-Python-App/create-python-app/issues/1).
12+
> **Status:** CLI monorepo bootstrapped. Template bank: [`cpa-templates`](https://github.com/Create-Python-App/cpa-templates). Roadmap: [#1](https://github.com/Create-Python-App/create-python-app/issues/1).
13+
14+
## Ecosystem
15+
16+
| Repository | Role |
17+
|------------|------|
18+
| [create-python-app](https://github.com/Create-Python-App/create-python-app) (this repo) | CLI (`create-awesome-python-app`) and scaffolding engine (`create-python-app-core`) |
19+
| [cpa-templates](https://github.com/Create-Python-App/cpa-templates) | Official templates and extensions (`templates.json` catalog) |
20+
21+
The CLI fetches the catalog from:
22+
23+
`https://raw.githubusercontent.com/Create-Python-App/cpa-templates/main/templates.json`
24+
25+
Override with `CPA_CATALOG_URL` for forks or local testing (`file://` supported).
1326

1427
## Install (preview)
1528

@@ -86,4 +99,5 @@ docker run --rm create-awesome-python-app --help
8699
### Reference
87100

88101
- [uv workspaces handbook](https://pydevtools.com/handbook/how-to/how-to-set-up-a-python-monorepo-with-uv-workspaces/)
89-
- Node parity: [Create-Node-App/create-node-app](https://github.com/Create-Node-App/create-node-app)
102+
- [cpa-templates](https://github.com/Create-Python-App/cpa-templates) — template and extension bank
103+
- Node parity: [Create-Node-App/create-node-app](https://github.com/Create-Node-App/create-node-app) + [cna-templates](https://github.com/Create-Node-App/cna-templates)

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,14 @@ Please open a private security advisory on GitHub or email the maintainers.
1010
Do not open a public issue for undisclosed vulnerabilities.
1111

1212
OSV scanning runs via `.github/workflows/osv-scanner.yml`.
13+
14+
## Network endpoints
15+
16+
The CLI may fetch remote resources when scaffolding or refreshing the template catalog:
17+
18+
| Host | Purpose | Timeout | User-Agent |
19+
|------|---------|---------|------------|
20+
| `raw.githubusercontent.com` | Template catalog `templates.json` from `cpa-templates` | 10 s | `create-awesome-python-app/<version>` |
21+
| `github.com` | Template and extension repositories (git clone) || git |
22+
23+
Override the catalog URL with `CPA_CATALOG_URL`. Use `CPA_OFFLINE=1` / `--offline` and local `file://` URLs when working air-gapped.

docs/CPA_TEMPLATES_TRACKING.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,28 @@
11
# Tracking: `cpa-templates` + website
22

3-
Tracked by https://github.com/Create-Python-App/create-python-app/issues/44
3+
Previously tracked by https://github.com/Create-Python-App/create-python-app/issues/44 (closed).
44

5-
Checklist:
5+
## Status
66

7-
- [ ] Create `Create-Python-App/cpa-templates`
8-
- [ ] Seed README + `templates.json`
9-
- [ ] Wire catalog URL in CLI
7+
- [x] Create `Create-Python-App/cpa-templates`
8+
- [x] Seed README + `templates.json`
9+
- [x] `fastapi-starter` template + initial extensions
10+
- [x] Wire catalog URL in CLI (`CPA_CATALOG_URL`, default raw GitHub URL)
11+
- [x] Integration tests against `cpa-templates` checkout
1012
- [ ] Website (optional, later)
13+
14+
## Repositories
15+
16+
| Repo | URL |
17+
|------|-----|
18+
| CLI monorepo | https://github.com/Create-Python-App/create-python-app |
19+
| Template bank | https://github.com/Create-Python-App/cpa-templates |
20+
21+
## CNA parity reference
22+
23+
| CNA | CPA |
24+
|-----|-----|
25+
| `create-node-app` | `create-python-app` |
26+
| `cna-templates` | `cpa-templates` |
27+
| `cna.config.json` | `cpa.config.json` |
28+
| `~/.cache/cna` | `~/.cache/cpa` |

0 commit comments

Comments
 (0)