xquik-haystack 0.1.0__py3-none-any.whl

haystack_integrations/components/websearch/py.typed

@@ -0,0 +1 @@
+

haystack_integrations/components/websearch/xquik/__init__.py

@@ -0,0 +1,10 @@
+# SPDX-FileCopyrightText: 2026-present Xquik <support@xquik.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.xquik.xquik_websearch import (
+    XquikTweetSearch,
+    XquikUserTweetsFetcher,
+)
+
+__all__ = ["XquikTweetSearch", "XquikUserTweetsFetcher"]

haystack_integrations/components/websearch/xquik/xquik_websearch.py

@@ -0,0 +1,417 @@
+# SPDX-FileCopyrightText: 2026-present Xquik <support@xquik.com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, Literal
+from urllib.parse import quote
+
+from haystack import Document, component, logging
+from haystack.utils import Secret
+from haystack.utils.requests_utils import async_request_with_retry, request_with_retry
+
+logger = logging.getLogger(__name__)
+
+XQUIK_API_URL = "https://xquik.com/api/v1"
+XQUIK_API_CONTRACT = "2026-04-29"
+
+QueryType = Literal["Latest", "Top"]
+JsonObject = Mapping[str, Any]
+
+
+@component
+class XquikTweetSearch:
+    """
+    Search public X/Twitter posts with Xquik and return Haystack Documents.
+
+    The component calls `GET /x/tweets/search`, sends an `x-api-key` header, and opts in to the
+    current Xquik response contract. Unit tests should mock HTTP calls.
+
+    ### Usage example
+
+    ```python
+    from haystack.utils import Secret
+    from haystack_integrations.components.websearch.xquik import XquikTweetSearch
+
+    search = XquikTweetSearch(api_key=Secret.from_env_var("XQUIK_API_KEY"), top_k=10)
+    result = search.run(query="haystack ai")
+    documents = result["documents"]
+    ```
+    """
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("XQUIK_API_KEY"),
+        top_k: int | None = 20,
+        query_type: QueryType = "Latest",
+        base_url: str = XQUIK_API_URL,
+        extra_params: dict[str, Any] | None = None,
+        timeout: int = 10,
+        max_retries: int = 3,
+    ) -> None:
+        """
+        Initialize the XquikTweetSearch component.
+
+        :param api_key:
+            Xquik API key. Defaults to the `XQUIK_API_KEY` environment variable.
+        :param top_k:
+            Maximum number of tweets to request. Maps to the Xquik `limit` query parameter.
+        :param query_type:
+            Xquik search ordering. Use `Latest` for chronological results or `Top` for engagement-ranked results.
+        :param base_url:
+            Base Xquik API URL. Defaults to `https://xquik.com/api/v1`.
+        :param extra_params:
+            Additional query parameters passed to the tweet search endpoint.
+        :param timeout:
+            Timeout in seconds for the HTTP request.
+        :param max_retries:
+            Maximum retry attempts for transient request failures.
+        """
+        self.api_key = api_key
+        self.top_k = top_k
+        self.query_type = query_type
+        self.base_url = base_url.rstrip("/")
+        self.extra_params = extra_params
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    @component.output_types(documents=list[Document], links=list[str], has_more=bool, next_cursor=str | None)
+    def run(
+        self,
+        query: str,
+        top_k: int | None = None,
+        query_type: QueryType | None = None,
+        cursor: str | None = None,
+        since_time: str | None = None,
+        until_time: str | None = None,
+    ) -> dict[str, Any]:
+        """
+        Search public tweets and return Haystack Documents.
+
+        :param query:
+            X search query string, including standard X query operators.
+        :param top_k:
+            Optional per-run override for the maximum number of tweets.
+        :param query_type:
+            Optional per-run override for Xquik search ordering.
+        :param cursor:
+            Optional pagination cursor from a previous response.
+        :param since_time:
+            Optional ISO 8601 lower bound for tweet creation time.
+        :param until_time:
+            Optional ISO 8601 upper bound for tweet creation time.
+        :returns:
+            A dictionary with `documents`, `links`, `has_more`, and `next_cursor`.
+        """
+        params = self._build_params(
+            query=query,
+            top_k=top_k,
+            query_type=query_type,
+            cursor=cursor,
+            since_time=since_time,
+            until_time=until_time,
+        )
+        response = request_with_retry(
+            attempts=self.max_retries,
+            method="GET",
+            url=f"{self.base_url}/x/tweets/search",
+            params=params,
+            headers=_build_headers(self.api_key),
+            timeout=self.timeout,
+        )
+        response.raise_for_status()
+        return _parse_tweets_response(response.json(), endpoint="x.tweets.search")
+
+    @component.output_types(documents=list[Document], links=list[str], has_more=bool, next_cursor=str | None)
+    async def run_async(
+        self,
+        query: str,
+        top_k: int | None = None,
+        query_type: QueryType | None = None,
+        cursor: str | None = None,
+        since_time: str | None = None,
+        until_time: str | None = None,
+    ) -> dict[str, Any]:
+        """
+        Asynchronously search public tweets and return Haystack Documents.
+
+        :param query:
+            X search query string, including standard X query operators.
+        :param top_k:
+            Optional per-run override for the maximum number of tweets.
+        :param query_type:
+            Optional per-run override for Xquik search ordering.
+        :param cursor:
+            Optional pagination cursor from a previous response.
+        :param since_time:
+            Optional ISO 8601 lower bound for tweet creation time.
+        :param until_time:
+            Optional ISO 8601 upper bound for tweet creation time.
+        :returns:
+            A dictionary with `documents`, `links`, `has_more`, and `next_cursor`.
+        """
+        params = self._build_params(
+            query=query,
+            top_k=top_k,
+            query_type=query_type,
+            cursor=cursor,
+            since_time=since_time,
+            until_time=until_time,
+        )
+        response = await async_request_with_retry(
+            attempts=self.max_retries,
+            method="GET",
+            url=f"{self.base_url}/x/tweets/search",
+            params=params,
+            headers=_build_headers(self.api_key),
+            timeout=self.timeout,
+        )
+        response.raise_for_status()
+        return _parse_tweets_response(response.json(), endpoint="x.tweets.search")
+
+    def _build_params(
+        self,
+        query: str,
+        top_k: int | None,
+        query_type: QueryType | None,
+        cursor: str | None,
+        since_time: str | None,
+        until_time: str | None,
+    ) -> dict[str, Any]:
+        effective_top_k = self.top_k if top_k is None else top_k
+        effective_query_type = self.query_type if query_type is None else query_type
+        params: dict[str, Any] = {"q": query, "queryType": effective_query_type}
+        if effective_top_k is not None:
+            params["limit"] = effective_top_k
+        if cursor is not None:
+            params["cursor"] = cursor
+        if since_time is not None:
+            params["sinceTime"] = since_time
+        if until_time is not None:
+            params["untilTime"] = until_time
+        if self.extra_params:
+            params.update(self.extra_params)
+        return params
+
+
+@component
+class XquikUserTweetsFetcher:
+    """
+    Fetch recent public posts for a user with Xquik and return Haystack Documents.
+
+    The component calls `GET /x/users/{id}/tweets`, where `id` can be an X user ID or username.
+    Unit tests should mock HTTP calls.
+    """
+
+    def __init__(
+        self,
+        api_key: Secret = Secret.from_env_var("XQUIK_API_KEY"),
+        include_replies: bool = False,
+        include_parent_tweet: bool = False,
+        base_url: str = XQUIK_API_URL,
+        timeout: int = 10,
+        max_retries: int = 3,
+    ) -> None:
+        """
+        Initialize the XquikUserTweetsFetcher component.
+
+        :param api_key:
+            Xquik API key. Defaults to the `XQUIK_API_KEY` environment variable.
+        :param include_replies:
+            Include reply tweets in the user timeline response.
+        :param include_parent_tweet:
+            Include parent tweet data for replies when available.
+        :param base_url:
+            Base Xquik API URL. Defaults to `https://xquik.com/api/v1`.
+        :param timeout:
+            Timeout in seconds for the HTTP request.
+        :param max_retries:
+            Maximum retry attempts for transient request failures.
+        """
+        self.api_key = api_key
+        self.include_replies = include_replies
+        self.include_parent_tweet = include_parent_tweet
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    @component.output_types(documents=list[Document], links=list[str], has_more=bool, next_cursor=str | None)
+    def run(
+        self,
+        user_id: str,
+        cursor: str | None = None,
+        include_replies: bool | None = None,
+        include_parent_tweet: bool | None = None,
+    ) -> dict[str, Any]:
+        """
+        Fetch recent public tweets for a user and return Haystack Documents.
+
+        :param user_id:
+            X user ID or username.
+        :param cursor:
+            Optional pagination cursor from a previous response.
+        :param include_replies:
+            Optional per-run override for including replies.
+        :param include_parent_tweet:
+            Optional per-run override for including parent tweet data.
+        :returns:
+            A dictionary with `documents`, `links`, `has_more`, and `next_cursor`.
+        """
+        params = self._build_params(
+            cursor=cursor,
+            include_replies=include_replies,
+            include_parent_tweet=include_parent_tweet,
+        )
+        response = request_with_retry(
+            attempts=self.max_retries,
+            method="GET",
+            url=f"{self.base_url}/x/users/{quote(user_id, safe='')}/tweets",
+            params=params,
+            headers=_build_headers(self.api_key),
+            timeout=self.timeout,
+        )
+        response.raise_for_status()
+        return _parse_tweets_response(response.json(), endpoint="x.users.tweets")
+
+    @component.output_types(documents=list[Document], links=list[str], has_more=bool, next_cursor=str | None)
+    async def run_async(
+        self,
+        user_id: str,
+        cursor: str | None = None,
+        include_replies: bool | None = None,
+        include_parent_tweet: bool | None = None,
+    ) -> dict[str, Any]:
+        """
+        Asynchronously fetch recent public tweets for a user and return Haystack Documents.
+
+        :param user_id:
+            X user ID or username.
+        :param cursor:
+            Optional pagination cursor from a previous response.
+        :param include_replies:
+            Optional per-run override for including replies.
+        :param include_parent_tweet:
+            Optional per-run override for including parent tweet data.
+        :returns:
+            A dictionary with `documents`, `links`, `has_more`, and `next_cursor`.
+        """
+        params = self._build_params(
+            cursor=cursor,
+            include_replies=include_replies,
+            include_parent_tweet=include_parent_tweet,
+        )
+        response = await async_request_with_retry(
+            attempts=self.max_retries,
+            method="GET",
+            url=f"{self.base_url}/x/users/{quote(user_id, safe='')}/tweets",
+            params=params,
+            headers=_build_headers(self.api_key),
+            timeout=self.timeout,
+        )
+        response.raise_for_status()
+        return _parse_tweets_response(response.json(), endpoint="x.users.tweets")
+
+    def _build_params(
+        self,
+        cursor: str | None,
+        include_replies: bool | None,
+        include_parent_tweet: bool | None,
+    ) -> dict[str, Any]:
+        params: dict[str, Any] = {
+            "includeReplies": self.include_replies if include_replies is None else include_replies,
+            "includeParentTweet": self.include_parent_tweet if include_parent_tweet is None else include_parent_tweet,
+        }
+        if cursor is not None:
+            params["cursor"] = cursor
+        return params
+
+
+def _build_headers(api_key: Secret) -> dict[str, str]:
+    return {
+        "Accept": "application/json",
+        "x-api-key": api_key.resolve_value() or "",
+        "xquik-api-contract": XQUIK_API_CONTRACT,
+    }
+
+
+def _parse_tweets_response(response: JsonObject, endpoint: str) -> dict[str, Any]:
+    documents: list[Document] = []
+    links: list[str] = []
+
+    tweets = _as_list(_get(response, "tweets", "data", default=[]))
+    for tweet in tweets:
+        if not isinstance(tweet, Mapping):
+            continue
+        document = _tweet_to_document(tweet, endpoint=endpoint)
+        documents.append(document)
+        url = document.meta.get("url")
+        if isinstance(url, str) and url:
+            links.append(url)
+
+    has_more = bool(_get(response, "has_more", "has_next_page", "hasMore", default=False))
+    next_cursor = _as_optional_string(_get(response, "next_cursor", "nextCursor", default=None))
+    return {"documents": documents, "links": links, "has_more": has_more, "next_cursor": next_cursor}
+
+
+def _tweet_to_document(tweet: JsonObject, endpoint: str) -> Document:
+    content = _as_optional_string(_get(tweet, "text", "full_text", "content", default="")) or ""
+    meta: dict[str, Any] = {"endpoint": endpoint}
+    for key, aliases in {
+        "id": ("id",),
+        "url": ("url",),
+        "created_at": ("created_at", "createdAt"),
+        "lang": ("lang",),
+        "conversation_id": ("conversation_id", "conversationId"),
+        "in_reply_to_id": ("in_reply_to_id", "inReplyToId"),
+        "in_reply_to_user_id": ("in_reply_to_user_id", "inReplyToUserId"),
+        "in_reply_to_username": ("in_reply_to_username", "inReplyToUsername"),
+        "is_reply": ("is_reply", "isReply"),
+        "is_quote_status": ("is_quote_status", "isQuoteStatus"),
+        "like_count": ("like_count", "likeCount"),
+        "retweet_count": ("retweet_count", "retweetCount"),
+        "reply_count": ("reply_count", "replyCount"),
+        "quote_count": ("quote_count", "quoteCount"),
+        "view_count": ("view_count", "viewCount"),
+        "bookmark_count": ("bookmark_count", "bookmarkCount"),
+    }.items():
+        value = _get(tweet, *aliases, default=None)
+        if value is not None:
+            meta[key] = value
+
+    author = _get(tweet, "author", "user", default=None)
+    if isinstance(author, Mapping):
+        meta["author"] = _compact(
+            {
+                "id": _get(author, "id", default=None),
+                "username": _get(author, "username", "screen_name", default=None),
+                "name": _get(author, "name", default=None),
+                "verified": _get(author, "verified", default=None),
+            }
+        )
+
+    return Document(content=content, meta=meta)
+
+
+def _get(data: JsonObject, *keys: str, default: Any) -> Any:
+    for key in keys:
+        if key in data:
+            return data[key]
+    return default
+
+
+def _as_list(value: Any) -> list[Any]:
+    if isinstance(value, list):
+        return value
+    return []
+
+
+def _as_optional_string(value: Any) -> str | None:
+    if value is None:
+        return None
+    return str(value)
+
+
+def _compact(data: dict[str, Any]) -> dict[str, Any]:
+    return {key: value for key, value in data.items() if value is not None}

xquik_haystack-0.1.0.dist-info/METADATA

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: xquik-haystack
+Version: 0.1.0
+Summary: Haystack web search components for Xquik public X data
+Project-URL: Documentation, https://docs.xquik.com/guides/haystack
+Project-URL: Issues, https://github.com/Xquik-dev/xquik-haystack/issues
+Project-URL: Source, https://github.com/Xquik-dev/xquik-haystack
+Author-email: Xquik <support@xquik.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: haystack,retrieval,social-media,twitter,websearch,x,xquik
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai
+Requires-Dist: httpx>=0.24
+Description-Content-Type: text/markdown
+
+# Xquik Haystack
+
+Haystack web search components for retrieving public X/Twitter context through the Xquik REST API.
+
+Documentation: <https://docs.xquik.com/guides/haystack>
+
+This package is maintained by Xquik as a standalone Haystack integration. It follows the `haystack_integrations` namespace convention and exposes read-only components under:
+
+```python
+from haystack_integrations.components.websearch.xquik import XquikTweetSearch, XquikUserTweetsFetcher
+```
+
+## Components
+
+- `XquikTweetSearch`: calls `GET /x/tweets/search` and returns matching posts as Haystack `Document` objects.
+- `XquikUserTweetsFetcher`: calls `GET /x/users/{id}/tweets` and returns recent public posts for a user as Haystack `Document` objects.
+
+Both components:
+
+- read the API key from `XQUIK_API_KEY` by default
+- accept `haystack.utils.Secret` for explicit API key injection
+- send the `x-api-key` and `xquik-api-contract: 2026-04-29` headers
+- keep `base_url` configurable for tests and controlled deployments
+- return `documents`, `links`, `has_more`, and `next_cursor`
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install xquik-haystack
+```
+
+## Usage
+
+### Tweet Search
+
+```python
+from haystack import Pipeline
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.xquik import XquikTweetSearch
+
+search = XquikTweetSearch(api_key=Secret.from_env_var("XQUIK_API_KEY"), top_k=10)
+
+pipeline = Pipeline()
+pipeline.add_component("x_search", search)
+
+result = pipeline.run({"x_search": {"query": "haystack ai"}})
+documents = result["x_search"]["documents"]
+```
+
+### User Tweets
+
+```python
+from haystack.utils import Secret
+from haystack_integrations.components.websearch.xquik import XquikUserTweetsFetcher
+
+fetcher = XquikUserTweetsFetcher(api_key=Secret.from_env_var("XQUIK_API_KEY"))
+
+result = fetcher.run(user_id="xquikcom", include_replies=False)
+documents = result["documents"]
+```
+
+## Document Mapping
+
+Each tweet becomes a Haystack `Document`.
+
+- `Document.content`: tweet text, or an empty string when text is missing
+- `Document.meta["endpoint"]`: Xquik endpoint family used by the component
+- `Document.meta["id"]`: tweet ID when present
+- `Document.meta["url"]`: tweet URL when present
+- `Document.meta["created_at"]`: tweet creation time when present
+- `Document.meta["author"]`: author ID, username, display name, and verification status when present
+- `Document.meta` also includes available public metrics such as like, repost, reply, quote, view, and bookmark counts
+
+## Development
+
+This project uses [Hatch](https://hatch.pypa.io/) for build and environment management.
+
+```bash
+pip install hatch
+hatch run fmt-check
+hatch run test:unit
+hatch build
+```
+
+Unit tests mock all Xquik HTTP calls. Integration tests can be added later behind an `XQUIK_API_KEY` check.
+
+## Publishing
+
+The release workflow publishes to PyPI with trusted publishing when a GitHub release is published.
+
+After a first PyPI version is published, submit a listing PR to [`deepset-ai/haystack-integrations`](https://github.com/deepset-ai/haystack-integrations) as requested by the Haystack maintainers.
+
+## License
+
+`xquik-haystack` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

xquik_haystack-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+haystack_integrations/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/websearch/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+haystack_integrations/components/websearch/xquik/__init__.py,sha256=-f48GWmlFDcPMjRBSQQqgOyl0nBRponHnmNmSrd7qCc,295
+haystack_integrations/components/websearch/xquik/xquik_websearch.py,sha256=az2ntrVCGcKkB3qd8656lZhmD7mzo-TqqmgIqds0XM4,15232
+xquik_haystack-0.1.0.dist-info/METADATA,sha256=tc13Xo3kq0237B-8PijPoO8WkJiKAW5yLe6-B9-1-RY,4437
+xquik_haystack-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+xquik_haystack-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+xquik_haystack-0.1.0.dist-info/RECORD,,

xquik_haystack-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xquik_haystack-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.