groundx 2.0.11__tar.gz

groundx-2.0.11/PKG-INFO

@@ -0,0 +1,177 @@
+Metadata-Version: 2.1
+Name: groundx
+Version: 2.0.11
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Eyelevel Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Feyelevelai%2Fgroundx-python)
+[![pypi](https://img.shields.io/pypi/v/groundx)](https://pypi.python.org/pypi/groundx)
+
+The Eyelevel Python library provides convenient access to the Eyelevel API from Python.
+
+## Installation
+
+```sh
+pip install groundx
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from groundx import GroundX
+from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+
+client = GroundX(
+    api_key="YOUR_API_KEY",
+)
+client.documents.ingest_remote(
+    documents=[
+        DocumentRemoteIngestRequestDocumentsItem(
+            bucket_id=1234,
+            source_url="https://my.source.url.com/file.txt",
+        )
+    ],
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from groundx import AsyncGroundX
+from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+
+client = AsyncGroundX(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.documents.ingest_remote(
+        documents=[
+            DocumentRemoteIngestRequestDocumentsItem(
+                bucket_id=1234,
+                source_url="https://my.source.url.com/file.txt",
+            )
+        ],
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from groundx.core.api_error import ApiError
+
+try:
+    client.documents.ingest_remote(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.documents.ingest_remote(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.documents.ingest_remote(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

groundx-2.0.11/README.md

@@ -0,0 +1,150 @@
+# Eyelevel Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Feyelevelai%2Fgroundx-python)
+[![pypi](https://img.shields.io/pypi/v/groundx)](https://pypi.python.org/pypi/groundx)
+
+The Eyelevel Python library provides convenient access to the Eyelevel API from Python.
+
+## Installation
+
+```sh
+pip install groundx
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from groundx import GroundX
+from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+
+client = GroundX(
+    api_key="YOUR_API_KEY",
+)
+client.documents.ingest_remote(
+    documents=[
+        DocumentRemoteIngestRequestDocumentsItem(
+            bucket_id=1234,
+            source_url="https://my.source.url.com/file.txt",
+        )
+    ],
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from groundx import AsyncGroundX
+from groundx.documents import DocumentRemoteIngestRequestDocumentsItem
+
+client = AsyncGroundX(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.documents.ingest_remote(
+        documents=[
+            DocumentRemoteIngestRequestDocumentsItem(
+                bucket_id=1234,
+                source_url="https://my.source.url.com/file.txt",
+            )
+        ],
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from groundx.core.api_error import ApiError
+
+try:
+    client.documents.ingest_remote(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.documents.ingest_remote(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.documents.ingest_remote(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from groundx import GroundX
+
+client = GroundX(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

groundx-2.0.11/pyproject.toml

@@ -0,0 +1,61 @@
+[tool.poetry]
+name = "groundx"
+version = "2.0.11"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "groundx", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/eyelevelai/groundx-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "^0.5.6"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

groundx-2.0.11/src/groundx/__init__.py

@@ -0,0 +1,107 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    BoundingBoxDetail,
+    BucketDetail,
+    BucketListResponse,
+    BucketResponse,
+    BucketUpdateDetail,
+    BucketUpdateResponse,
+    CustomerDetail,
+    CustomerResponse,
+    DocumentDetail,
+    DocumentListResponse,
+    DocumentLookupResponse,
+    DocumentResponse,
+    DocumentType,
+    GroupDetail,
+    GroupListResponse,
+    GroupResponse,
+    HealthResponse,
+    HealthResponseHealth,
+    HealthService,
+    HealthServiceStatus,
+    IngestResponse,
+    IngestResponseIngest,
+    MessageResponse,
+    MeterDetail,
+    ProcessStatusResponse,
+    ProcessStatusResponseIngest,
+    ProcessStatusResponseIngestProgress,
+    ProcessStatusResponseIngestProgressCancelled,
+    ProcessStatusResponseIngestProgressComplete,
+    ProcessStatusResponseIngestProgressErrors,
+    ProcessStatusResponseIngestProgressProcessing,
+    ProcessingStatus,
+    SearchResponse,
+    SearchResponseSearch,
+    SearchResultItem,
+    Sort,
+    SortOrder,
+    SubscriptionDetail,
+    SubscriptionDetailMeters,
+)
+from .errors import BadRequestError, UnauthorizedError
+from . import buckets, customer, documents, groups, health, search
+from .client import AsyncGroundX, GroundX
+from .documents import DocumentRemoteIngestRequestDocumentsItem, WebsiteCrawlRequestWebsitesItem
+from .environment import GroundXEnvironment
+from .search import SearchContentRequestId
+from .version import __version__
+
+__all__ = [
+    "AsyncGroundX",
+    "BadRequestError",
+    "BoundingBoxDetail",
+    "BucketDetail",
+    "BucketListResponse",
+    "BucketResponse",
+    "BucketUpdateDetail",
+    "BucketUpdateResponse",
+    "CustomerDetail",
+    "CustomerResponse",
+    "DocumentDetail",
+    "DocumentListResponse",
+    "DocumentLookupResponse",
+    "DocumentRemoteIngestRequestDocumentsItem",
+    "DocumentResponse",
+    "DocumentType",
+    "GroundX",
+    "GroundXEnvironment",
+    "GroupDetail",
+    "GroupListResponse",
+    "GroupResponse",
+    "HealthResponse",
+    "HealthResponseHealth",
+    "HealthService",
+    "HealthServiceStatus",
+    "IngestResponse",
+    "IngestResponseIngest",
+    "MessageResponse",
+    "MeterDetail",
+    "ProcessStatusResponse",
+    "ProcessStatusResponseIngest",
+    "ProcessStatusResponseIngestProgress",
+    "ProcessStatusResponseIngestProgressCancelled",
+    "ProcessStatusResponseIngestProgressComplete",
+    "ProcessStatusResponseIngestProgressErrors",
+    "ProcessStatusResponseIngestProgressProcessing",
+    "ProcessingStatus",
+    "SearchContentRequestId",
+    "SearchResponse",
+    "SearchResponseSearch",
+    "SearchResultItem",
+    "Sort",
+    "SortOrder",
+    "SubscriptionDetail",
+    "SubscriptionDetailMeters",
+    "UnauthorizedError",
+    "WebsiteCrawlRequestWebsitesItem",
+    "__version__",
+    "buckets",
+    "customer",
+    "documents",
+    "groups",
+    "health",
+    "search",
+]

groundx-2.0.11/src/groundx/buckets/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+