Skip to content

Commit 6d5b78e

Browse files
owenthcareyowenthcarey
committed
chore(repo,ci,docs): rename demo to examples/hello-world and update refs
1 parent 7725b14 commit 6d5b78e

File tree

12 files changed

+11
-12
lines changed

12 files changed

+11
-12
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
3434
- name: Format check (Black)
3535
run: |
36-
black --check src apps tests
36+
black --check src examples tests
3737
3838
- name: Type check (MyPy)
3939
run: |

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ pip install -e .
2020
pytest -q
2121

2222
# format and lint
23-
black src apps tests || true
23+
black src examples tests || true
2424
ruff check .
2525
```
2626

@@ -33,8 +33,8 @@ pn --help
3333
# create a new sample app (template fetch is remote)
3434
pn init my_app
3535

36-
# run a local demo app skeleton
37-
cd apps/pythonnative_demo && pn run android
36+
# run the Hello World example
37+
cd examples/hello-world && pn run android
3838
```
3939

4040
## Project layout (high‑level)
@@ -44,9 +44,8 @@ cd apps/pythonnative_demo && pn run android
4444
- `cli/` – `pn` command
4545
- `tests/` – unit tests for the library
4646
- `templates/` – Android/iOS project templates and zips
47-
- `apps/` – application projects
48-
- `django_pythonnative/` – Django project for docs/demo hosting and E2E
49-
- `pythonnative_demo/` – minimal demo app using the library
47+
- `examples/` – runnable example apps
48+
- `hello-world/` – minimal demo app using the library
5049
- `experiments/` – platform experiments (Android/iOS/Briefcase)
5150
- `README.md`, `pyproject.toml` – repo docs and packaging
5251

@@ -62,7 +61,7 @@ Common commands:
6261
```bash
6362
pytest -q # run tests
6463
ruff check . # lint
65-
black src apps tests # format
64+
black src examples tests # format
6665
```
6766

6867
## Conventional Commits
@@ -107,11 +106,10 @@ Recommended scopes (match the smallest accurate directory/module):
107106

108107
- Templates and examples:
109108
- `templates` – `templates/` (Android/iOS templates, zips)
110-
- `demo` – `apps/pythonnative_demo/`
109+
- `examples` – `examples/` (e.g., `hello-world/`)
111110
- `experiments` – `experiments/`
112111

113-
- Django app and site:
114-
- `django` – `apps/django_pythonnative/` (site, docs pages, E2E harness)
112+
<!-- Django app and site removed: the old Django project has been retired -->
115113

116114
- Repo‑level and ops:
117115
- `deps` – dependency updates and version pins

apps/pythonnative_demo/.gitignore renamed to examples/hello-world/.gitignore

File renamed without changes.

apps/pythonnative_demo/README.md renamed to examples/hello-world/README.md

File renamed without changes.

apps/pythonnative_demo/app/__init__.py renamed to examples/hello-world/app/__init__.py

File renamed without changes.

apps/pythonnative_demo/app/main_page.py renamed to examples/hello-world/app/main_page.py

File renamed without changes.

apps/pythonnative_demo/app/resources/.gitkeep renamed to examples/hello-world/app/resources/.gitkeep

File renamed without changes.

apps/pythonnative_demo/app/second_page.py renamed to examples/hello-world/app/second_page.py

File renamed without changes.

apps/pythonnative_demo/pythonnative.json renamed to examples/hello-world/pythonnative.json

File renamed without changes.

apps/pythonnative_demo/requirements.txt renamed to examples/hello-world/requirements.txt

File renamed without changes.

0 commit comments

Comments
 (0)