cliver-playbook-app-basic 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. cliver_playbook_app_basic-0.1.0/.gitignore +19 -0
  2. cliver_playbook_app_basic-0.1.0/LICENSE +201 -0
  3. cliver_playbook_app_basic-0.1.0/PKG-INFO +79 -0
  4. cliver_playbook_app_basic-0.1.0/README.md +55 -0
  5. cliver_playbook_app_basic-0.1.0/alembic.ini +45 -0
  6. cliver_playbook_app_basic-0.1.0/pyproject.toml +85 -0
  7. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/__init__.py +12 -0
  8. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/__main__.py +33 -0
  9. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/alembic/__init__.py +57 -0
  10. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/alembic/env.py +91 -0
  11. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/alembic/script.py.mako +26 -0
  12. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/alembic/versions/0001_basic_items.py +54 -0
  13. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/alembic/versions/0002_app_settings.py +47 -0
  14. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/api/__init__.py +0 -0
  15. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/api/items.py +58 -0
  16. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/api/meta.py +27 -0
  17. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/api/routes.py +20 -0
  18. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/app.py +48 -0
  19. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/config_yaml.py +220 -0
  20. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/db/__init__.py +0 -0
  21. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/db/base.py +7 -0
  22. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/db/session.py +31 -0
  23. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/models/__init__.py +0 -0
  24. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/models/entities.py +83 -0
  25. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/runtime.py +160 -0
  26. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/runtime_settings.py +557 -0
  27. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/schemas/__init__.py +0 -0
  28. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/schemas/item.py +31 -0
  29. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/services/__init__.py +0 -0
  30. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/services/items.py +50 -0
  31. cliver_playbook_app_basic-0.1.0/src/cliver_playbook/app/basic/settings.py +162 -0
  32. cliver_playbook_app_basic-0.1.0/tests/__init__.py +0 -0
  33. cliver_playbook_app_basic-0.1.0/tests/conftest.py +99 -0
  34. cliver_playbook_app_basic-0.1.0/tests/dsn.py +14 -0
  35. cliver_playbook_app_basic-0.1.0/tests/test_config.py +130 -0
  36. cliver_playbook_app_basic-0.1.0/tests/test_items.py +62 -0
  37. cliver_playbook_app_basic-0.1.0/tests/test_lifespan.py +18 -0
  38. cliver_playbook_app_basic-0.1.0/tests/test_meta.py +15 -0
  39. cliver_playbook_app_basic-0.1.0/tests/test_runtime_settings.py +93 -0
@@ -0,0 +1,19 @@
1
+ # Python: virtualenvs, caches, build artifacts (workspace root and packages)
2
+ .venv/
3
+ __pycache__/
4
+ *.py[cod]
5
+ .pytest_cache/
6
+ .ruff_cache/
7
+ dist/
8
+ build/
9
+ *.egg-info/
10
+
11
+ # Local configuration and secrets — only .env.example files are committed
12
+ .env
13
+ var/
14
+
15
+ # Claude/Superpowers local design, plan, and note documents
16
+ docs/superpowers/
17
+
18
+ # Node (frontend packages)
19
+ node_modules/
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,79 @@
1
+ Metadata-Version: 2.5
2
+ Name: cliver-playbook-app-basic
3
+ Version: 0.1.0
4
+ Summary: cliver-playbook foundations: layered settings, process runtime, meta + demo Items API, own Alembic chain
5
+ Project-URL: Repository, https://github.com/cliver-project/cliver-playbook
6
+ Author: Lin Gao
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ Requires-Python: >=3.12
10
+ Requires-Dist: alembic>=1.16.0
11
+ Requires-Dist: asyncpg>=0.30.0
12
+ Requires-Dist: fastapi>=0.143.0
13
+ Requires-Dist: greenlet>=3.1.0
14
+ Requires-Dist: httpx>=0.28.0
15
+ Requires-Dist: jinja2>=3.1
16
+ Requires-Dist: psycopg[binary]>=3.2.0
17
+ Requires-Dist: pydantic-settings<3,>=2.16
18
+ Requires-Dist: pydantic>=2.11.0
19
+ Requires-Dist: python-dotenv>=1.0
20
+ Requires-Dist: pyyaml>=6.0
21
+ Requires-Dist: sqlalchemy>=2.0.36
22
+ Requires-Dist: uvicorn[standard]>=0.35.0
23
+ Description-Content-Type: text/markdown
24
+
25
+ # cliver-playbook-app-basic
26
+
27
+ Foundations package of the cliver-playbook library — everything a service
28
+ needs before business code: layered settings, the process runtime, and one
29
+ runnable API slice.
30
+
31
+ ## What is inside
32
+
33
+ | Area | Path (under `src/cliver_playbook/app/basic/`) | Notes |
34
+ |---|---|---|
35
+ | Settings | `settings.py` | Layered: env > .env > runtime overrides > app.yaml (Jinja2) > defaults. Subclass `Settings` to extend (ADR-0016). |
36
+ | Runtime | `runtime.py` | `configure(settings)` binds settings + async engine once per process; nothing is built at import time. |
37
+ | Runtime settings | `runtime_settings.py` | Package-owned settings sections: field description, validation, live apply, `app_settings` persistence and the lifespan overlay (ADR-0021). |
38
+ | Routers | `api/routes.py` | `ROUTERS: list[APIRouter]` — a composed app includes them (ADR-0015). |
39
+ | Demo slice | `api/items.py`, `services/`, `schemas/`, `models/entities.py` | Full CRUD example: the `items` table and `/api/v1/items`. Optional — delete together with its migration and tests. |
40
+ | Migrations | `alembic/` | Own chain, version table `alembic_version_basic`; creates `items` and `app_settings`. |
41
+ | Application | `app.py`, `__main__.py` | `create_app()` and `python -m cliver_playbook.app.basic`. |
42
+
43
+ ## Install
44
+
45
+ ```bash
46
+ python -m pip install -e . # from this directory
47
+ # consuming project, same virtualenv (dependency first, then this):
48
+ python -m pip install -e ../cliver-playbook-app-basic
49
+ ```
50
+
51
+ Editable installs of sibling packages coexist in one virtualenv: the
52
+ `cliver_playbook` and `cliver_playbook.app` namespace directories are
53
+ PEP 420 — deliberately no `__init__.py` — so every package's portion merges.
54
+
55
+ ## Run standalone
56
+
57
+ ```bash
58
+ docker compose up -d db # or point CLIVER_DATABASE_URL at PostgreSQL
59
+ python -m cliver_playbook.app.basic --reload
60
+ # GET /api/v1/health, /api/v1/version, /api/v1/items
61
+ ```
62
+
63
+ Configuration resolves relative to the current working directory: the nearest
64
+ ancestor containing `app.yaml` or `.env` is the application root (`CLIVER_CONFIG_FILE`
65
+ overrides). See `settings.py` and `config_yaml.py`.
66
+
67
+ ## Migrate
68
+
69
+ ```bash
70
+ python -c "from cliver_playbook.app.basic.alembic import run_migrations_online; run_migrations_online()"
71
+ # interactive, from this directory:
72
+ alembic upgrade head
73
+ ```
74
+
75
+ ## Test
76
+
77
+ ```bash
78
+ python -m pytest # needs PostgreSQL; creates and drops a temp database
79
+ ```
@@ -0,0 +1,55 @@
1
+ # cliver-playbook-app-basic
2
+
3
+ Foundations package of the cliver-playbook library — everything a service
4
+ needs before business code: layered settings, the process runtime, and one
5
+ runnable API slice.
6
+
7
+ ## What is inside
8
+
9
+ | Area | Path (under `src/cliver_playbook/app/basic/`) | Notes |
10
+ |---|---|---|
11
+ | Settings | `settings.py` | Layered: env > .env > runtime overrides > app.yaml (Jinja2) > defaults. Subclass `Settings` to extend (ADR-0016). |
12
+ | Runtime | `runtime.py` | `configure(settings)` binds settings + async engine once per process; nothing is built at import time. |
13
+ | Runtime settings | `runtime_settings.py` | Package-owned settings sections: field description, validation, live apply, `app_settings` persistence and the lifespan overlay (ADR-0021). |
14
+ | Routers | `api/routes.py` | `ROUTERS: list[APIRouter]` — a composed app includes them (ADR-0015). |
15
+ | Demo slice | `api/items.py`, `services/`, `schemas/`, `models/entities.py` | Full CRUD example: the `items` table and `/api/v1/items`. Optional — delete together with its migration and tests. |
16
+ | Migrations | `alembic/` | Own chain, version table `alembic_version_basic`; creates `items` and `app_settings`. |
17
+ | Application | `app.py`, `__main__.py` | `create_app()` and `python -m cliver_playbook.app.basic`. |
18
+
19
+ ## Install
20
+
21
+ ```bash
22
+ python -m pip install -e . # from this directory
23
+ # consuming project, same virtualenv (dependency first, then this):
24
+ python -m pip install -e ../cliver-playbook-app-basic
25
+ ```
26
+
27
+ Editable installs of sibling packages coexist in one virtualenv: the
28
+ `cliver_playbook` and `cliver_playbook.app` namespace directories are
29
+ PEP 420 — deliberately no `__init__.py` — so every package's portion merges.
30
+
31
+ ## Run standalone
32
+
33
+ ```bash
34
+ docker compose up -d db # or point CLIVER_DATABASE_URL at PostgreSQL
35
+ python -m cliver_playbook.app.basic --reload
36
+ # GET /api/v1/health, /api/v1/version, /api/v1/items
37
+ ```
38
+
39
+ Configuration resolves relative to the current working directory: the nearest
40
+ ancestor containing `app.yaml` or `.env` is the application root (`CLIVER_CONFIG_FILE`
41
+ overrides). See `settings.py` and `config_yaml.py`.
42
+
43
+ ## Migrate
44
+
45
+ ```bash
46
+ python -c "from cliver_playbook.app.basic.alembic import run_migrations_online; run_migrations_online()"
47
+ # interactive, from this directory:
48
+ alembic upgrade head
49
+ ```
50
+
51
+ ## Test
52
+
53
+ ```bash
54
+ python -m pytest # needs PostgreSQL; creates and drops a temp database
55
+ ```
@@ -0,0 +1,45 @@
1
+ # Alembic configuration for cliver-playbook-app-basic's own migration chain.
2
+ # Used for INTERACTIVE development (`alembic upgrade head` from this
3
+ # directory); the programmatic entry points in alembic/__init__.py build an
4
+ # equivalent config without an ini file, and both share alembic/env.py.
5
+ #
6
+ # The database URL is NOT set here — env.py resolves it from application
7
+ # settings so there is a single source of truth and zero secret duplication.
8
+ [alembic]
9
+ script_location = src/cliver_playbook/app/basic/alembic
10
+ file_template = %%(rev)s_%%(slug)s
11
+ path_separator = os
12
+
13
+ [loggers]
14
+ keys = root,sqlalchemy,alembic
15
+
16
+ [handlers]
17
+ keys = console
18
+
19
+ [formatters]
20
+ keys = generic
21
+
22
+ [logger_root]
23
+ level = WARN
24
+ handlers = console
25
+ qualname =
26
+
27
+ [logger_sqlalchemy]
28
+ level = WARN
29
+ handlers =
30
+ qualname = sqlalchemy.engine
31
+
32
+ [logger_alembic]
33
+ level = INFO
34
+ handlers =
35
+ qualname = alembic
36
+
37
+ [handler_console]
38
+ class = StreamHandler
39
+ args = (sys.stderr,)
40
+ level = NOTSET
41
+ formatter = generic
42
+
43
+ [formatter_generic]
44
+ format = %(levelname)-5.5s [%(name)s] %(message)s
45
+ datefmt = %H:%M:%S
@@ -0,0 +1,85 @@
1
+ [project]
2
+ name = "cliver-playbook-app-basic"
3
+ version = "0.1.0"
4
+ description = "cliver-playbook foundations: layered settings, process runtime, meta + demo Items API, own Alembic chain"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = ["LICENSE"]
8
+ authors = [{ name = "Lin Gao" }]
9
+ requires-python = ">=3.12"
10
+ dependencies = [
11
+ # Web framework and server
12
+ "fastapi>=0.143.0",
13
+ "uvicorn[standard]>=0.35.0",
14
+ # Database: async SQLAlchemy over asyncpg at runtime; psycopg (sync) is the
15
+ # Alembic-only driver. settings.py derives both URLs from one CLIVER_DATABASE_URL.
16
+ "sqlalchemy>=2.0.36",
17
+ "alembic>=1.16.0",
18
+ "asyncpg>=0.30.0",
19
+ "psycopg[binary]>=3.2.0",
20
+ "greenlet>=3.1.0",
21
+ # Configuration and validation
22
+ "pydantic>=2.11.0",
23
+ # 2.16 introduced the YamlConfigSettingsSource._read_file seam that
24
+ # config_yaml.py subclasses; the upper bound guards that private API
25
+ # against silent breakage (tests fail loudly if it moves).
26
+ "pydantic-settings>=2.16,<3",
27
+ # Layered config: the app.yaml tier is Jinja2-rendered, then YAML-parsed.
28
+ "jinja2>=3.1",
29
+ "pyyaml>=6.0",
30
+ # Read directly by config_yaml.py for the template env() helper's
31
+ # .env fallback (also a transitive pydantic-settings dependency).
32
+ "python-dotenv>=1.0",
33
+ # HTTP client (outbound calls)
34
+ "httpx>=0.28.0",
35
+ ]
36
+
37
+ [project.urls]
38
+ Repository = "https://github.com/cliver-project/cliver-playbook"
39
+
40
+ [dependency-groups]
41
+ dev = [
42
+ "pytest>=8.3.0",
43
+ "pytest-asyncio>=0.24.0",
44
+ "anyio>=4.4.0",
45
+ "ruff>=0.8.0",
46
+ ]
47
+
48
+ [build-system]
49
+ requires = ["hatchling"]
50
+ build-backend = "hatchling.build"
51
+
52
+ [tool.hatch.build.targets.wheel]
53
+ # The wheel ships this distribution's subtree of the shared
54
+ # `cliver_playbook.app` namespace. The `cliver_playbook/` and
55
+ # `cliver_playbook/app/` directories deliberately have NO __init__.py
56
+ # (PEP 420): every distribution contributes one portion and the import
57
+ # system merges them, which is also what lets editable installs of several
58
+ # cliver-playbook packages coexist in one virtualenv.
59
+ packages = ["src/cliver_playbook"]
60
+ # Editable installs (pip install -e) get a plain `_<dist>.pth` file adding
61
+ # `src/` to sys.path — the only editable mode that keeps the namespace merge
62
+ # working with sibling packages installed the same way. Never set
63
+ # dev-mode-exact: it requires __init__.py files and its finder would shadow
64
+ # the other packages' namespace portions.
65
+ dev-mode-dirs = ["src"]
66
+
67
+ [tool.pytest.ini_options]
68
+ # No pythonpath tricks: the tests import the *installed* package, so a broken
69
+ # install fails the suite instead of being masked by the source tree.
70
+ asyncio_mode = "auto"
71
+
72
+ [tool.ruff]
73
+ line-length = 100
74
+ target-version = "py312"
75
+
76
+ [tool.ruff.lint]
77
+ # B008: FastAPI's `Depends(...)` in argument defaults is the framework idiom.
78
+ ignore = ["B008"]
79
+
80
+ [tool.ruff.lint.isort]
81
+ # `cliver_playbook` is ONE namespace shared by several distributions: pin it
82
+ # as first-party in every package, or import grouping would depend on which
83
+ # subtree the current distribution happens to own (ruff otherwise classifies
84
+ # the sibling packages' modules as third-party).
85
+ known-first-party = ["cliver_playbook"]
@@ -0,0 +1,12 @@
1
+ """basic: the foundations package — settings, runtime, and a demo API slice.
2
+
3
+ Public surface only; every name below is a plain import (no settings reads,
4
+ no engine, no app assembly — importing a package must never have side
5
+ effects; see ADR-0015 and ADR-0016).
6
+ """
7
+
8
+ from cliver_playbook.app.basic.api.routes import ROUTERS
9
+ from cliver_playbook.app.basic.app import create_app
10
+ from cliver_playbook.app.basic.settings import Settings, get_settings, settings
11
+
12
+ __all__ = ["ROUTERS", "Settings", "create_app", "get_settings", "settings"]
@@ -0,0 +1,33 @@
1
+ """Standalone entry point: ``python -m cliver_playbook.app.basic``.
2
+
3
+ Runs the package's self-application with uvicorn. The factory string (rather
4
+ than an app instance) keeps ``--reload`` working, which requires uvicorn to
5
+ re-import the application in a subprocess — import safety is what makes that
6
+ cheap.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import argparse
12
+
13
+ import uvicorn
14
+
15
+ _FACTORY = "cliver_playbook.app.basic.app:create_app"
16
+
17
+
18
+ def main() -> None:
19
+ parser = argparse.ArgumentParser(description="Run the basic package's application.")
20
+ parser.add_argument("--host", default="127.0.0.1", help="Bind address (default: 127.0.0.1).")
21
+ parser.add_argument("--port", type=int, default=8000, help="Bind port (default: 8000).")
22
+ parser.add_argument(
23
+ "--reload",
24
+ action="store_true",
25
+ help="Restart on source changes (development only).",
26
+ )
27
+ args = parser.parse_args()
28
+
29
+ uvicorn.run(_FACTORY, factory=True, host=args.host, port=args.port, reload=args.reload)
30
+
31
+
32
+ if __name__ == "__main__":
33
+ main()
@@ -0,0 +1,57 @@
1
+ """Programmatic migration entry points for the ``basic`` package.
2
+
3
+ Every package owns its migration chain and exposes the same two functions, so
4
+ a project initializes its whole database by calling each package's
5
+ ``run_migrations_online`` in dependency order (basic first, then the packages
6
+ built on it) — no alembic.ini paths, no working-directory assumptions.
7
+
8
+ The interactive CLI remains available for development: run ``alembic`` from
9
+ the package directory, which picks up the bundled alembic.ini. Both routes
10
+ share ``alembic/env.py`` and therefore the same version table.
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ from pathlib import Path
16
+
17
+ from alembic import command
18
+ from alembic.config import Config
19
+
20
+ # env.py lives next to this module inside the installed package, so the
21
+ # script location is correct regardless of where the package is imported from.
22
+ _SCRIPT_LOCATION = Path(__file__).resolve().parent
23
+
24
+
25
+ def make_config(database_url: str | None = None) -> Config:
26
+ """Build an Alembic config for this package's chain.
27
+
28
+ No ini file is involved: the script location is pinned to the installed
29
+ package and the URL is passed through explicitly — omitted entirely when
30
+ no URL is given, letting env.py fall back to application settings.
31
+ Logging configuration is likewise untouched: in-process migrations must
32
+ not reconfigure the host application's loggers.
33
+ """
34
+ config = Config()
35
+ config.set_main_option("script_location", str(_SCRIPT_LOCATION))
36
+ if database_url:
37
+ config.set_main_option("sqlalchemy.url", database_url)
38
+ return config
39
+
40
+
41
+ def run_migrations_online(database_url: str | None = None) -> None:
42
+ """Upgrade this package's chain to head against a live database.
43
+
44
+ Args:
45
+ database_url: sync (psycopg) DSN to migrate. When omitted, the
46
+ process runtime's current settings decide (see alembic/env.py).
47
+ """
48
+ command.upgrade(make_config(database_url), "head")
49
+
50
+
51
+ def run_migrations_offline(database_url: str | None = None) -> None:
52
+ """Print the equivalent upgrade SQL to stdout without connecting.
53
+
54
+ Offline mode still needs a URL (or settings) to render SQL for the right
55
+ dialect; nothing is executed against a database.
56
+ """
57
+ command.upgrade(make_config(database_url), "head", sql=True)