cliver-playbook-app-basic 0.1.0__py3-none-any.whl
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.
- cliver_playbook/app/basic/__init__.py +12 -0
- cliver_playbook/app/basic/__main__.py +33 -0
- cliver_playbook/app/basic/alembic/__init__.py +57 -0
- cliver_playbook/app/basic/alembic/env.py +91 -0
- cliver_playbook/app/basic/alembic/script.py.mako +26 -0
- cliver_playbook/app/basic/alembic/versions/0001_basic_items.py +54 -0
- cliver_playbook/app/basic/alembic/versions/0002_app_settings.py +47 -0
- cliver_playbook/app/basic/api/__init__.py +0 -0
- cliver_playbook/app/basic/api/items.py +58 -0
- cliver_playbook/app/basic/api/meta.py +27 -0
- cliver_playbook/app/basic/api/routes.py +20 -0
- cliver_playbook/app/basic/app.py +48 -0
- cliver_playbook/app/basic/config_yaml.py +220 -0
- cliver_playbook/app/basic/db/__init__.py +0 -0
- cliver_playbook/app/basic/db/base.py +7 -0
- cliver_playbook/app/basic/db/session.py +31 -0
- cliver_playbook/app/basic/models/__init__.py +0 -0
- cliver_playbook/app/basic/models/entities.py +83 -0
- cliver_playbook/app/basic/runtime.py +160 -0
- cliver_playbook/app/basic/runtime_settings.py +557 -0
- cliver_playbook/app/basic/schemas/__init__.py +0 -0
- cliver_playbook/app/basic/schemas/item.py +31 -0
- cliver_playbook/app/basic/services/__init__.py +0 -0
- cliver_playbook/app/basic/services/items.py +50 -0
- cliver_playbook/app/basic/settings.py +162 -0
- cliver_playbook_app_basic-0.1.0.dist-info/METADATA +79 -0
- cliver_playbook_app_basic-0.1.0.dist-info/RECORD +29 -0
- cliver_playbook_app_basic-0.1.0.dist-info/WHEEL +4 -0
- cliver_playbook_app_basic-0.1.0.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
"""Application settings for the ``basic`` package — the extensibility root.
|
|
2
|
+
|
|
3
|
+
Single source of truth for configuration *structure*: the fields below define
|
|
4
|
+
what every cliver-playbook application configures; sibling packages subclass
|
|
5
|
+
``Settings`` to add their own fields (ADR-0016). Values come from a layered
|
|
6
|
+
resolution (highest precedence first):
|
|
7
|
+
|
|
8
|
+
constructor kwargs > CLIVER_-prefixed environment > project .env
|
|
9
|
+
> project app.yaml (Jinja2-rendered) > field defaults
|
|
10
|
+
|
|
11
|
+
The YAML layer (see config_yaml.py) is optional and checked in with
|
|
12
|
+
non-secret defaults; env/.env carry per-deployment values and secrets. The
|
|
13
|
+
``CLIVER_`` env prefix is a fixed convention — note that YAML keys are the
|
|
14
|
+
*bare field names*, without the prefix.
|
|
15
|
+
|
|
16
|
+
Import safety: nothing here reads configuration at import time. The
|
|
17
|
+
module-level ``settings`` is a lazy proxy that resolves to the
|
|
18
|
+
process-configured instance (``runtime.configure``, called by every
|
|
19
|
+
``create_app``) or, when the process was never configured, to this package's
|
|
20
|
+
own ``Settings()`` built on first attribute access (ADR-0016).
|
|
21
|
+
|
|
22
|
+
Database URL contract (ADR-0001):
|
|
23
|
+
- ``CLIVER_DATABASE_URL`` holds the *canonical* form ``postgresql://user:pass@host:port/db``.
|
|
24
|
+
- ``db_url`` derives the asyncpg DSN used by the application at runtime.
|
|
25
|
+
- ``sync_db_url`` derives the psycopg DSN used by Alembic only.
|
|
26
|
+
- The default matches the bundled docker-compose database, so a fresh
|
|
27
|
+
checkout starts with zero configuration; real deployments override it.
|
|
28
|
+
An explicitly-empty value still refuses to start — fail fast beats a
|
|
29
|
+
cryptic connection error deep inside the first query.
|
|
30
|
+
"""
|
|
31
|
+
|
|
32
|
+
from __future__ import annotations
|
|
33
|
+
|
|
34
|
+
from typing import Any
|
|
35
|
+
|
|
36
|
+
from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, SettingsConfigDict
|
|
37
|
+
|
|
38
|
+
from cliver_playbook.app.basic.config_yaml import (
|
|
39
|
+
JinjaYamlSource,
|
|
40
|
+
resolve_config_path,
|
|
41
|
+
resolve_env_file,
|
|
42
|
+
)
|
|
43
|
+
from cliver_playbook.app.basic.runtime import lazy_settings
|
|
44
|
+
|
|
45
|
+
# Matches the db service in docker-compose.yml (make db-up) — see class doc.
|
|
46
|
+
_DEFAULT_DATABASE_URL = "postgresql://cliver:cliver@127.0.0.1:5432/cliver_app"
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
class Settings(BaseSettings):
|
|
50
|
+
model_config = SettingsConfigDict(
|
|
51
|
+
env_prefix="CLIVER_",
|
|
52
|
+
# Unknown env vars are ignored on purpose: the shell carries plenty of
|
|
53
|
+
# non-Settings CLIVER_* helpers (e.g. CLIVER_TEST_DATABASE_URL for the
|
|
54
|
+
# test bootstrap), and BaseSettings' default `forbid` would reject them.
|
|
55
|
+
extra="ignore",
|
|
56
|
+
# "__" separates nesting levels when an env var overrides a composite
|
|
57
|
+
# field, e.g. CLIVER_OIDC__PROVIDERS__GOOGLE__CLIENT_SECRET (used by
|
|
58
|
+
# the user-management package's provider registry). Dict keys that
|
|
59
|
+
# arrive through env are lowercased by pydantic-settings.
|
|
60
|
+
env_nested_delimiter="__",
|
|
61
|
+
)
|
|
62
|
+
|
|
63
|
+
def __init__(self, **values: Any) -> None:
|
|
64
|
+
"""Resolve the .env layer dynamically, unless the caller overrode it.
|
|
65
|
+
|
|
66
|
+
An installed package has no fixed relationship to the project
|
|
67
|
+
consuming it, so the .env location is discovered per instantiation by
|
|
68
|
+
walking up from the current working directory (see
|
|
69
|
+
``resolve_env_file``) — a path frozen into ``model_config`` or derived
|
|
70
|
+
from ``__file__`` would point into site-packages.
|
|
71
|
+
|
|
72
|
+
An explicit ``_env_file`` kwarg always wins: tests point it at a temp
|
|
73
|
+
file for hermeticity, and ``_env_file=None`` disables the layer
|
|
74
|
+
entirely — both are stock pydantic-settings semantics.
|
|
75
|
+
"""
|
|
76
|
+
if "_env_file" not in values:
|
|
77
|
+
values["_env_file"] = resolve_env_file()
|
|
78
|
+
super().__init__(**values)
|
|
79
|
+
|
|
80
|
+
@classmethod
|
|
81
|
+
def settings_customise_sources(
|
|
82
|
+
cls,
|
|
83
|
+
settings_cls: type[BaseSettings],
|
|
84
|
+
init_settings: PydanticBaseSettingsSource,
|
|
85
|
+
env_settings: PydanticBaseSettingsSource,
|
|
86
|
+
dotenv_settings: PydanticBaseSettingsSource,
|
|
87
|
+
file_secret_settings: PydanticBaseSettingsSource,
|
|
88
|
+
) -> tuple[PydanticBaseSettingsSource, ...]:
|
|
89
|
+
"""Layered precedence: env > .env > app.yaml > field defaults.
|
|
90
|
+
|
|
91
|
+
Tuple order IS precedence (first source holding a value wins). The
|
|
92
|
+
YAML layer is appended last as the Jinja2-rendered source; the stock
|
|
93
|
+
`file_secret_settings` (secrets_dir mechanism) is dropped — this stack
|
|
94
|
+
keeps secrets in the environment, not in a secrets directory.
|
|
95
|
+
|
|
96
|
+
The config-file path resolves per instantiation (not once at class
|
|
97
|
+
creation) so tests can point $CLIVER_CONFIG_FILE at a temp file and
|
|
98
|
+
construct a fresh Settings() directly.
|
|
99
|
+
"""
|
|
100
|
+
return (
|
|
101
|
+
init_settings,
|
|
102
|
+
env_settings,
|
|
103
|
+
dotenv_settings,
|
|
104
|
+
JinjaYamlSource(settings_cls, yaml_file=resolve_config_path()),
|
|
105
|
+
)
|
|
106
|
+
|
|
107
|
+
# Canonical PostgreSQL URL. Default = the bundled compose db (zero-config
|
|
108
|
+
# local development); override for any other environment.
|
|
109
|
+
database_url: str = _DEFAULT_DATABASE_URL
|
|
110
|
+
|
|
111
|
+
# Display name: FastAPI title and frontend branding.
|
|
112
|
+
app_name: str = "cliver-app"
|
|
113
|
+
|
|
114
|
+
log_level: str = "INFO"
|
|
115
|
+
|
|
116
|
+
# Note: there is deliberately no API-prefix field. Routers own static
|
|
117
|
+
# prefixes (see api/routes.py) — an APIRouter's prefix is fixed at import
|
|
118
|
+
# time, so a settings-driven prefix would freeze whichever Settings
|
|
119
|
+
# instance happened to load first while making the URL surface invisible
|
|
120
|
+
# in the route table.
|
|
121
|
+
|
|
122
|
+
def _require_database_url(self) -> str:
|
|
123
|
+
if not self.database_url:
|
|
124
|
+
raise RuntimeError(
|
|
125
|
+
"CLIVER_DATABASE_URL is set to an empty value. "
|
|
126
|
+
"Point it at your PostgreSQL instance, or run `make db-up` "
|
|
127
|
+
"to start the bundled container and keep the default."
|
|
128
|
+
)
|
|
129
|
+
return self.database_url
|
|
130
|
+
|
|
131
|
+
@property
|
|
132
|
+
def db_url(self) -> str:
|
|
133
|
+
"""Async DSN (asyncpg driver) for application runtime."""
|
|
134
|
+
return (
|
|
135
|
+
self._require_database_url()
|
|
136
|
+
.replace("postgresql://", "postgresql+asyncpg://", 1)
|
|
137
|
+
.replace("postgresql+psycopg://", "postgresql+asyncpg://", 1)
|
|
138
|
+
)
|
|
139
|
+
|
|
140
|
+
@property
|
|
141
|
+
def sync_db_url(self) -> str:
|
|
142
|
+
"""Sync DSN (psycopg driver) for Alembic. Never share engines across drivers."""
|
|
143
|
+
return (
|
|
144
|
+
self._require_database_url()
|
|
145
|
+
.replace("postgresql+asyncpg://", "postgresql+psycopg://", 1)
|
|
146
|
+
.replace("postgresql://", "postgresql+psycopg://", 1)
|
|
147
|
+
)
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
# Process-aware lazy proxy: resolves to the runtime-bound instance (any
|
|
151
|
+
# package's Settings subclass) or to a lazily built Settings() of this class.
|
|
152
|
+
settings = lazy_settings(Settings)
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
def get_settings() -> Settings:
|
|
156
|
+
"""Return the process-wide Settings instance (see ``settings`` above).
|
|
157
|
+
|
|
158
|
+
Kept as a function for call sites written against the previous
|
|
159
|
+
accessor: returns the runtime-bound instance when the process is
|
|
160
|
+
configured, else this package's own lazily-built ``Settings()``.
|
|
161
|
+
"""
|
|
162
|
+
return settings.resolve()
|
|
@@ -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,29 @@
|
|
|
1
|
+
cliver_playbook/app/basic/__init__.py,sha256=EXGT7vGXoeziP24WBZYncBx9LG_ltWLgCCIIcHVKpVY,537
|
|
2
|
+
cliver_playbook/app/basic/__main__.py,sha256=tyvM0kAjJl9CWbyccRZtYEZdaD8Dgedm_T_y2Vnm10E,1044
|
|
3
|
+
cliver_playbook/app/basic/app.py,sha256=h8PAskYxlTUDJ5rGXOVeOB86WrpkUnsvGZXc57ACvRg,1854
|
|
4
|
+
cliver_playbook/app/basic/config_yaml.py,sha256=EpLtogTAWPEXFqHcO_8H2xeiyDxFe8AvSiaUUVgymA4,9546
|
|
5
|
+
cliver_playbook/app/basic/runtime.py,sha256=SQ8AfEpGAg13VgTlXsjaQ3EiyBv1MsawBUgeFNxEO1g,5781
|
|
6
|
+
cliver_playbook/app/basic/runtime_settings.py,sha256=8AE4UPH_G9ak5lUHfOKXyUdphTQ4lFIaab8TXaX4f8I,22090
|
|
7
|
+
cliver_playbook/app/basic/settings.py,sha256=CnG8Dr3xdFj1kr8jibItteZ50ocAGUZXv86urNefH60,6995
|
|
8
|
+
cliver_playbook/app/basic/alembic/__init__.py,sha256=CKDk_AGFASU6aT0hlCf_M5G-sPvp-9c88m4eBvzPSq4,2290
|
|
9
|
+
cliver_playbook/app/basic/alembic/env.py,sha256=DjeGXHYdjaU8aM7uCgmu_UCO7VAS0AjDSGdF_gx1eHw,3507
|
|
10
|
+
cliver_playbook/app/basic/alembic/script.py.mako,sha256=0uO9Wj7-5yGEDTrt3c8q_G-i83t8VEJYaLuwij1laYk,637
|
|
11
|
+
cliver_playbook/app/basic/alembic/versions/0001_basic_items.py,sha256=pzQh8ezJIl3hXUWEFKqSsmcjEnV-vp6yeSmj1uzJVHQ,1855
|
|
12
|
+
cliver_playbook/app/basic/alembic/versions/0002_app_settings.py,sha256=hzfGkUvVR48KMoDMyeNoSevvFvRXjDosvd2-WiUCULw,1389
|
|
13
|
+
cliver_playbook/app/basic/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
14
|
+
cliver_playbook/app/basic/api/items.py,sha256=WvJW8EvVZAcvWTd3iWBCYr9hQFeR39M7MLup75y_i8Q,2378
|
|
15
|
+
cliver_playbook/app/basic/api/meta.py,sha256=4LdiVT9oArQdPO-vpaJGydE8cBj9H2DU5fHzYG-FlGM,1053
|
|
16
|
+
cliver_playbook/app/basic/api/routes.py,sha256=xG33TgHIb0hk_dKQL3bzH2Yt6HdounHuKxLWobyKslY,794
|
|
17
|
+
cliver_playbook/app/basic/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
18
|
+
cliver_playbook/app/basic/db/base.py,sha256=CWD2gyeD5MpRSfBKCMyIhAIwGZxc8UZPQ3inc14-inw,244
|
|
19
|
+
cliver_playbook/app/basic/db/session.py,sha256=4L3ttFTZE9USkj1W_Bx38PdAtu42z68AG6AKx_4GNrg,1149
|
|
20
|
+
cliver_playbook/app/basic/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
21
|
+
cliver_playbook/app/basic/models/entities.py,sha256=zox1AXqB9b7uu4DbgT4bwR1ItPh4iOJ-TDkCS77qv50,3066
|
|
22
|
+
cliver_playbook/app/basic/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
23
|
+
cliver_playbook/app/basic/schemas/item.py,sha256=x5-KAV0czh5Dz07kfVd-X3RvOqKeQ-ErkQn71XZcOPc,858
|
|
24
|
+
cliver_playbook/app/basic/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
25
|
+
cliver_playbook/app/basic/services/items.py,sha256=wgo3qmU49dlGboaeTUX3xIZtX1FmL6wNAhyGQ8uwsM4,1584
|
|
26
|
+
cliver_playbook_app_basic-0.1.0.dist-info/METADATA,sha256=1wOkPGcNQ7vCv537miSnNvz_MhGDW2ljPMeyrEsPuA0,3252
|
|
27
|
+
cliver_playbook_app_basic-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
|
|
28
|
+
cliver_playbook_app_basic-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
29
|
+
cliver_playbook_app_basic-0.1.0.dist-info/RECORD,,
|
|
@@ -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.
|