voxeye 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.
voxeye/__init__.py ADDED
@@ -0,0 +1,11 @@
1
+ from importlib.metadata import PackageNotFoundError, version
2
+
3
+ from voxeye._redaction import Redaction
4
+ from voxeye._tracer import Observability
5
+
6
+ try:
7
+ __version__ = version("voxeye")
8
+ except PackageNotFoundError: # not installed (e.g. running from source tree)
9
+ __version__ = "0.0.0"
10
+
11
+ __all__ = ["Observability", "Redaction", "__version__"]
voxeye/_lifecycle.py ADDED
@@ -0,0 +1,47 @@
1
+ from __future__ import annotations
2
+
3
+ import asyncio
4
+ import logging
5
+ from collections.abc import Mapping
6
+ from datetime import UTC, datetime
7
+ from typing import Any
8
+
9
+ import requests # transitive via opentelemetry-exporter-otlp-proto-http
10
+
11
+ _log = logging.getLogger("voxeye")
12
+
13
+
14
+ def send_ping(
15
+ *,
16
+ endpoint: str,
17
+ api_key: str,
18
+ call_id: str,
19
+ agent_id: str,
20
+ metadata: Mapping[str, Any],
21
+ ) -> None:
22
+ """Fire-and-forget POST to /v1/calls, off the event loop. Failures are non-fatal:
23
+ spans still flow via OTLP, so the lifecycle ping is a 'nice to have'."""
24
+ payload = {
25
+ "call_id": call_id,
26
+ "agent_id": agent_id,
27
+ "started_at": datetime.now(UTC).isoformat(),
28
+ "metadata": dict(metadata),
29
+ }
30
+ try:
31
+ loop = asyncio.get_running_loop()
32
+ except RuntimeError:
33
+ _log.debug("no running event loop; skipping lifecycle ping")
34
+ return
35
+ loop.run_in_executor(None, _post, f"{endpoint}/v1/calls", api_key, payload)
36
+
37
+
38
+ def _post(url: str, api_key: str, payload: dict[str, Any]) -> None:
39
+ try:
40
+ requests.post(
41
+ url,
42
+ json=payload,
43
+ timeout=5.0,
44
+ headers={"Authorization": f"Bearer {api_key}"},
45
+ )
46
+ except Exception as exc: # fail-open by design
47
+ _log.debug("lifecycle ping failed: %s", exc)
voxeye/_redaction.py ADDED
@@ -0,0 +1,85 @@
1
+ """Opt-out redaction: keep spans flowing, but drop sensitive fields before export.
2
+
3
+ Two layers, neither touches LiveKit's span emission:
4
+ - model-name resource attrs voxeye sets are simply not added (see _tracer).
5
+ - sensitive attributes LiveKit sets on spans are filtered at the export boundary by
6
+ RedactingSpanExporter — a thin wrapper that forwards redacted copies to the real
7
+ OTLP exporter. Live spans are never mutated (ReadableSpan.attributes is read-only).
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ import copy
13
+ from collections.abc import Sequence
14
+ from dataclasses import dataclass
15
+
16
+ from opentelemetry.sdk.trace import ReadableSpan
17
+ from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
18
+
19
+ # group toggle -> span attribute keys LiveKit emits that carry that data
20
+ _GROUP_KEYS: dict[str, tuple[str, ...]] = {
21
+ "model_names": ("gen_ai.request.model", "gen_ai.provider.name"),
22
+ "prompts": ("lk.instructions", "lk.chat_ctx"),
23
+ "transcripts": (
24
+ "lk.user_input",
25
+ "lk.user_transcript",
26
+ "lk.response.text",
27
+ "lk.input_text",
28
+ "lk.tts.input_text",
29
+ ),
30
+ "tool_io": ("lk.function_tool.arguments", "lk.function_tool.output"),
31
+ }
32
+
33
+
34
+ @dataclass(frozen=True)
35
+ class Redaction:
36
+ """What NOT to export. Defaults export everything; set a flag True to drop it.
37
+
38
+ - model_names: stt/llm/tts/vad provider+model identifiers (resource attrs AND the
39
+ gen_ai.* model attrs LiveKit sets on llm spans).
40
+ - prompts: system prompt / instructions (and the redundant chat context).
41
+ - transcripts: user transcripts and agent response text.
42
+ - tool_io: function-tool arguments and outputs.
43
+ - attributes: extra exact attribute keys to drop (escape hatch).
44
+ """
45
+
46
+ model_names: bool = False
47
+ prompts: bool = False
48
+ transcripts: bool = False
49
+ tool_io: bool = False
50
+ attributes: tuple[str, ...] = ()
51
+
52
+ def span_drop_keys(self) -> frozenset[str]:
53
+ keys: set[str] = set(self.attributes)
54
+ for group, group_keys in _GROUP_KEYS.items():
55
+ if getattr(self, group):
56
+ keys.update(group_keys)
57
+ return frozenset(keys)
58
+
59
+
60
+ class RedactingSpanExporter(SpanExporter):
61
+ """Forwards spans to `inner`, dropping `drop_keys` from each span's attributes."""
62
+
63
+ def __init__(self, inner: SpanExporter, drop_keys: frozenset[str]) -> None:
64
+ self._inner = inner
65
+ self._drop = drop_keys
66
+
67
+ def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult:
68
+ if not self._drop:
69
+ return self._inner.export(spans)
70
+ return self._inner.export([self._redact(s) for s in spans])
71
+
72
+ def _redact(self, span: ReadableSpan) -> ReadableSpan:
73
+ attrs = span.attributes or {}
74
+ if not any(k in attrs for k in self._drop):
75
+ return span
76
+ clean = {k: v for k, v in attrs.items() if k not in self._drop}
77
+ scrubbed = copy.copy(span) # shallow copy; only the attributes view changes
78
+ scrubbed._attributes = clean
79
+ return scrubbed
80
+
81
+ def force_flush(self, timeout_millis: int = 30_000) -> bool:
82
+ return self._inner.force_flush(timeout_millis)
83
+
84
+ def shutdown(self) -> None:
85
+ self._inner.shutdown()
voxeye/_resolve.py ADDED
@@ -0,0 +1,18 @@
1
+ from __future__ import annotations
2
+
3
+ from typing import Any
4
+
5
+
6
+ def resolve_agent_id(override: str | None, ctx: Any) -> str:
7
+ """Resolve agent_id via fallback chain: override → ctx.job.agent_name → "unknown".
8
+
9
+ The agent instance isn't available at attach() time (it's set inside
10
+ session.start(agent=...)), so the real label is reconciled server-side from the
11
+ agent_session span. This is the best-effort value for the lifecycle ping.
12
+ """
13
+ if override:
14
+ return override
15
+ job_name = getattr(getattr(ctx, "job", None), "agent_name", None)
16
+ if job_name:
17
+ return str(job_name)
18
+ return "unknown"
voxeye/_tracer.py ADDED
@@ -0,0 +1,140 @@
1
+ from __future__ import annotations
2
+
3
+ import logging
4
+ from collections.abc import Mapping
5
+ from dataclasses import dataclass, field
6
+ from typing import Any
7
+
8
+ from livekit.agents import AgentSession, JobContext
9
+ from livekit.agents.telemetry import set_tracer_provider
10
+ from livekit.agents.telemetry.traces import tracer as _lk_tracer
11
+ from opentelemetry.exporter.otlp.proto.http import Compression
12
+ from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
13
+ from opentelemetry.sdk.resources import SERVICE_NAME, Resource
14
+ from opentelemetry.sdk.trace import TracerProvider
15
+ from opentelemetry.sdk.trace.export import BatchSpanProcessor, SpanExporter
16
+
17
+ from voxeye._lifecycle import send_ping
18
+ from voxeye._redaction import RedactingSpanExporter, Redaction
19
+ from voxeye._resolve import resolve_agent_id
20
+ from voxeye.constants import DEFAULT_ENDPOINT
21
+
22
+ _log = logging.getLogger("voxeye")
23
+
24
+
25
+ def _introspect(component: object | None) -> dict[str, str] | None:
26
+ """Best-effort STT/LLM/TTS/VAD provider+model identification.
27
+
28
+ Plugins encode the provider in their module path; the model is usually in
29
+ `_opts.model`. Both are wrapped in try/except — any failure yields None, so this
30
+ never breaks attach().
31
+ """
32
+ if component is None:
33
+ return None
34
+ try:
35
+ parts = type(component).__module__.split(".")
36
+ provider = parts[-2] if len(parts) >= 2 else parts[-1]
37
+ model: str | None = None
38
+ if hasattr(component, "_opts") and hasattr(component._opts, "model"):
39
+ model = component._opts.model
40
+ elif hasattr(component, "model"):
41
+ model = component.model
42
+ return {"provider": provider, "model": str(model) if model else "unknown"}
43
+ except Exception:
44
+ return None
45
+
46
+
47
+ @dataclass(frozen=True)
48
+ class Observability:
49
+ """Configure OTel tracing + a lifecycle ping for a LiveKit Agents job.
50
+
51
+ Usage::
52
+
53
+ obs = Observability(api_key="sk_...") # module-level, pure
54
+
55
+ async def entrypoint(ctx: JobContext):
56
+ session = AgentSession(stt=..., llm=..., tts=...)
57
+ obs.attach(session, ctx) # sync, fail-open
58
+ await session.start(agent=MyAgent(), room=ctx.room)
59
+ """
60
+
61
+ api_key: str
62
+ endpoint: str = DEFAULT_ENDPOINT
63
+ debug: bool = False
64
+ redact: Redaction = field(default_factory=Redaction)
65
+
66
+ def attach(
67
+ self,
68
+ session: AgentSession[Any],
69
+ ctx: JobContext,
70
+ *,
71
+ agent_id: str | None = None,
72
+ metadata: Mapping[str, Any] | None = None,
73
+ ) -> None:
74
+ try:
75
+ endpoint = self.endpoint.rstrip("/")
76
+
77
+ # 1. Reset any prior provider — worker subprocesses are pooled and reused,
78
+ # so a TracerProvider from a previous job can persist in this process.
79
+ # Only a real SDK TracerProvider has flush/shutdown (the default is a
80
+ # ProxyTracerProvider); mirror LiveKit's own isinstance gate.
81
+ prior = getattr(_lk_tracer, "_tracer_provider", None)
82
+ if isinstance(prior, TracerProvider):
83
+ try:
84
+ prior.force_flush(timeout_millis=2000)
85
+ prior.shutdown()
86
+ except Exception as exc:
87
+ _log.debug("prior provider shutdown failed: %s", exc)
88
+
89
+ # 2. Resolve identifiers. call_id = job.id (room.sid isn't available until
90
+ # ctx.connect(), which session.start() triggers — too late for attach).
91
+ call_id = ctx.job.id
92
+ resolved_agent_id = resolve_agent_id(agent_id, ctx)
93
+
94
+ # 3. Build the Resource (inherited by every span).
95
+ resource_attrs: dict[str, str] = {
96
+ SERVICE_NAME: resolved_agent_id,
97
+ "agent.id": resolved_agent_id,
98
+ "call.id": call_id,
99
+ }
100
+ if not self.redact.model_names: # opt-out: don't even introspect models
101
+ for name in ("stt", "llm", "tts", "vad"):
102
+ info = _introspect(getattr(session, name, None))
103
+ if info:
104
+ resource_attrs[f"{name}.provider"] = info["provider"]
105
+ resource_attrs[f"{name}.model"] = info["model"]
106
+
107
+ # Filter sensitive span attributes at the export boundary (opt-out).
108
+ exporter: SpanExporter = OTLPSpanExporter(
109
+ endpoint=f"{endpoint}/v1/traces",
110
+ headers={"Authorization": f"Bearer {self.api_key}"},
111
+ compression=Compression.Gzip,
112
+ )
113
+ drop_keys = self.redact.span_drop_keys()
114
+ if drop_keys:
115
+ exporter = RedactingSpanExporter(exporter, drop_keys)
116
+
117
+ provider = TracerProvider(resource=Resource.create(resource_attrs))
118
+ provider.add_span_processor(BatchSpanProcessor(exporter))
119
+ set_tracer_provider(provider)
120
+
121
+ # 4. Flush spans on shutdown — runs before LiveKit's own telemetry shutdown.
122
+ async def _flush_on_shutdown(_reason: str) -> None:
123
+ try:
124
+ provider.force_flush(timeout_millis=5000)
125
+ provider.shutdown()
126
+ except Exception as exc:
127
+ _log.debug("provider flush/shutdown failed: %s", exc)
128
+
129
+ ctx.add_shutdown_callback(_flush_on_shutdown)
130
+
131
+ # 5. Lifecycle ping (fire-and-forget, fail-open).
132
+ send_ping(
133
+ endpoint=endpoint,
134
+ api_key=self.api_key,
135
+ call_id=call_id,
136
+ agent_id=resolved_agent_id,
137
+ metadata=dict(metadata) if metadata else {},
138
+ )
139
+ except Exception as exc: # never break the user's hot path
140
+ _log.warning("voxeye attach failed: %s", exc, exc_info=self.debug)
voxeye/constants.py ADDED
@@ -0,0 +1,10 @@
1
+ """Tunable constants for the voxeye SDK.
2
+
3
+ Update ``DEFAULT_ENDPOINT`` to your retina host before publishing for production use.
4
+ Callers can always override per-instance: ``Observability(api_key=..., endpoint=...)``.
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ # Base URL of the retina ingest service. The SDK appends ``/v1/traces`` and ``/v1/calls``.
10
+ DEFAULT_ENDPOINT = "http://localhost:8000"
voxeye/py.typed ADDED
File without changes
@@ -0,0 +1,138 @@
1
+ Metadata-Version: 2.4
2
+ Name: voxeye
3
+ Version: 0.1.0
4
+ Summary: OpenTelemetry observability for LiveKit Agents — ships transcripts, tool calls, prompts, and spans to a self-hosted ingest service in three lines.
5
+ Project-URL: Homepage, https://github.com/nilayguptaforwork-ctrl/voxeye
6
+ Project-URL: Repository, https://github.com/nilayguptaforwork-ctrl/voxeye
7
+ Project-URL: Documentation, https://github.com/nilayguptaforwork-ctrl/voxeye#readme
8
+ Project-URL: Issues, https://github.com/nilayguptaforwork-ctrl/voxeye/issues
9
+ Project-URL: Changelog, https://github.com/nilayguptaforwork-ctrl/voxeye/blob/main/CHANGELOG.md
10
+ Author: Manvendra Singh
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: agents,livekit,observability,opentelemetry,voice
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Framework :: AsyncIO
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: License :: OSI Approved :: Apache Software License
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Software Development :: Libraries
24
+ Classifier: Topic :: System :: Monitoring
25
+ Classifier: Typing :: Typed
26
+ Requires-Python: >=3.11
27
+ Requires-Dist: livekit-agents<2,>=1.5
28
+ Requires-Dist: opentelemetry-exporter-otlp-proto-http<1.42,>=1.39
29
+ Requires-Dist: opentelemetry-sdk<1.42,>=1.39
30
+ Provides-Extra: dev
31
+ Requires-Dist: mypy>=1.13; extra == 'dev'
32
+ Requires-Dist: pytest-asyncio>=0.25; extra == 'dev'
33
+ Requires-Dist: pytest>=8; extra == 'dev'
34
+ Requires-Dist: responses>=0.25; extra == 'dev'
35
+ Requires-Dist: ruff>=0.7; extra == 'dev'
36
+ Provides-Extra: examples
37
+ Requires-Dist: livekit-plugins-cartesia; extra == 'examples'
38
+ Requires-Dist: livekit-plugins-deepgram; extra == 'examples'
39
+ Requires-Dist: livekit-plugins-google; extra == 'examples'
40
+ Requires-Dist: livekit-plugins-silero; extra == 'examples'
41
+ Requires-Dist: python-dotenv>=1.0; extra == 'examples'
42
+ Requires-Dist: requests>=2.32; extra == 'examples'
43
+ Description-Content-Type: text/markdown
44
+
45
+ # voxeye
46
+
47
+ OpenTelemetry observability for [LiveKit Agents](https://github.com/livekit/agents). One
48
+ `pip install`, three lines of code, and every transcript, tool call, system prompt, span, and
49
+ per-component model identifier flows to a self-hosted [retina](../retina) ingest service.
50
+
51
+ No event listeners, no content buffering, no proprietary SDK lock-in — just OTel done right for
52
+ voice agents.
53
+
54
+ ## Install
55
+
56
+ ```bash
57
+ pip install voxeye
58
+ ```
59
+
60
+ ## Use
61
+
62
+ ```python
63
+ from voxeye import Observability
64
+ from livekit.agents import AgentSession, JobContext
65
+
66
+ obs = Observability(api_key="sk_...", endpoint="https://your-retina-host") # module-level, pure
67
+
68
+ async def entrypoint(ctx: JobContext):
69
+ session = AgentSession(stt=..., llm=..., tts=...)
70
+ obs.attach(session, ctx) # sync, fail-open
71
+ await session.start(agent=MyAgent(), room=ctx.room) # your existing line
72
+ ```
73
+
74
+ That's it. `attach()`:
75
+
76
+ 1. **Resets any prior `TracerProvider`** — LiveKit worker subprocesses are pooled and reused, so
77
+ a provider from a previous job can leak into the next one.
78
+ 2. **Resolves `call_id = ctx.job.id`** (`room.sid` isn't available until `ctx.connect()`).
79
+ 3. **Resolves `agent_id`** via `agent_id=` override → `ctx.job.agent_name` → `"unknown"` (the real
80
+ label is reconciled server-side from the `agent_session` span).
81
+ 4. **Introspects** `session.stt/.llm/.tts/.vad` for `{component}.provider` / `.model`, set as
82
+ resource attributes on every span — closing gaps LiveKit's plugin instrumentation leaves.
83
+ 5. **Installs an OTLP exporter** (gzip, bearer auth) and an async shutdown flush.
84
+ 6. **Fires a lifecycle ping** to `/v1/calls` for instant call existence + crash detection.
85
+
86
+ Every step is wrapped fail-open: `attach()` never raises into your entrypoint.
87
+
88
+ ## Redaction (opt out of exporting sensitive data)
89
+
90
+ By default everything is exported. Pass a `Redaction` to stop specific data from ever
91
+ leaving the process — it's filtered client-side (sensitive resource attrs aren't set, and
92
+ span attributes are dropped at the export boundary; live spans are never mutated):
93
+
94
+ ```python
95
+ from voxeye import Observability, Redaction
96
+
97
+ obs = Observability(
98
+ api_key="sk_...",
99
+ redact=Redaction(
100
+ prompts=True, # drop the system prompt / instructions
101
+ model_names=True, # drop stt/llm/tts/vad provider+model (resource AND gen_ai.* attrs)
102
+ transcripts=True, # drop user transcripts + agent response text
103
+ tool_io=True, # drop function-tool arguments + outputs
104
+ attributes=("my.custom.attr",), # escape hatch: extra exact keys to drop
105
+ ),
106
+ )
107
+ ```
108
+
109
+ Spans, durations, token counts, span tree, and tool *names* still flow — only the fields
110
+ you flag are withheld. Each flag defaults to `False` (export).
111
+
112
+ ## Notes
113
+
114
+ - `endpoint` defaults to `http://localhost:8000` (local retina). Point it at your host in prod.
115
+ - Call `attach()` **once** per entrypoint. Calling it twice replaces the provider mid-call.
116
+ - Requires `livekit-agents >= 1.0`.
117
+
118
+ ## Develop
119
+
120
+ ```bash
121
+ uv sync --extra dev
122
+ uv run pytest
123
+ uv run ruff check src tests && uv run mypy src
124
+ ```
125
+
126
+ ## Build & publish
127
+
128
+ ```bash
129
+ uv build # → dist/voxeye-<version>-py3-none-any.whl + .tar.gz
130
+ uvx twine check dist/* # validate metadata + README rendering
131
+ pip install dist/voxeye-*.whl # try it in a clean env
132
+ ```
133
+
134
+ Publishing to PyPI is automated via GitHub Actions **trusted publishing** (OIDC, no API
135
+ tokens) in `.github/workflows/publish.yml` — it runs on a published GitHub Release. Before
136
+ the first release: reserve the `voxeye` name on PyPI and add this repo as a
137
+ [trusted publisher](https://docs.pypi.org/trusted-publishers/). Until then the workflow is
138
+ inert. To publish manually instead: `uvx twine upload dist/*`.
@@ -0,0 +1,11 @@
1
+ voxeye/__init__.py,sha256=1AFhH-WFmXkioXuVq9l9kGT_Ewy3GQeZKV7ag8znAz8,346
2
+ voxeye/_lifecycle.py,sha256=-ylas52o8I4AQBfjKadSU1Rd2qeYwRj3N8TG7I8HhSk,1329
3
+ voxeye/_redaction.py,sha256=ur0zysepPfR4RhqzzyuHAJcqD3A97jhVBjyvKjN_AEA,3209
4
+ voxeye/_resolve.py,sha256=BA8BT0gmDPK_x3d55oBzBPKg-v2hV3OphsAeqF-NeDM,635
5
+ voxeye/_tracer.py,sha256=75hKOFE80f2opQ-UnzTNDdGFG2Hrtbr4yYFxKQOPtJo,5807
6
+ voxeye/constants.py,sha256=Z3xhDituBS5PqBqow6NB2w-NVu5sz5Eg4Ls0lngspjQ,391
7
+ voxeye/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
8
+ voxeye-0.1.0.dist-info/METADATA,sha256=rtXiZw81SPh52-VmSqH0ADNoTMoM59p16IJ6jwN1DHE,5905
9
+ voxeye-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
10
+ voxeye-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
11
+ voxeye-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.30.1
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -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.