newscatcher-catchall-sdk 0.1.0__tar.gz

newscatcher_catchall_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Newscatcher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

newscatcher_catchall_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.1
+Name: newscatcher-catchall-sdk
+Version: 0.1.0
+Summary: 
+License: MIT
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/Newscatcher/newscatcher-catchall-python
+Description-Content-Type: text/markdown
+
+# Newscatcher CatchAll 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%2FNewscatcher%2Fnewscatcher-catchall-python)
+[![pypi](https://img.shields.io/pypi/v/newscatcher-catchall-sdk)](https://pypi.python.org/pypi/newscatcher-catchall-sdk)
+
+The Newscatcher CatchAll Python library provides access to the [CatchAll API](https://www.newscatcherapi.com/docs/v3/catch-all/overview/introduction), which transforms natural language queries into structured data extracted from web sources.
+
+## Installation
+
+```sh
+pip install newscatcher-catchall-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+### Jobs
+
+Submit a query and retrieve structured results:
+
+```python
+from newscatcher_catchall import CatchAllApi
+import time
+
+client = CatchAllApi(api_key="YOUR_API_KEY")
+
+# Create a job
+job = client.jobs.create_job(
+    query="Tech company earnings this quarter",
+    context="Focus on revenue and profit margins",
+    schema="Company [NAME] earned [REVENUE] in [QUARTER]",
+)
+
+# Poll for completion
+while True:
+    status = client.jobs.get_job_status(job.job_id)
+    if status.status == "job_completed":
+        break
+    time.sleep(60)
+
+# Retrieve results
+results = client.jobs.get_job_results(job.job_id)
+for record in results.all_records:
+    print(record.record_title)
+    print(record.enrichment)
+```
+
+Jobs process asynchronously and typically complete in 10-15 minutes. To learn more, see the [Quickstart](https://www.newscatcherapi.com/docs/v3/catch-all/overview/quickstart).
+
+### Monitors
+
+Automate recurring queries with scheduled execution:
+
+```python
+from newscatcher_catchall import CatchAllApi
+
+client = CatchAllApi(api_key="YOUR_API_KEY")
+
+# Create a monitor from a completed job
+monitor = client.monitors.create_monitor(
+    reference_job_id=job.job_id,
+    schedule="every day at 12 PM UTC",
+    webhook={
+        "url": "https://your-endpoint.com/webhook",
+        "method": "POST",
+        "headers": {"Authorization": "Bearer YOUR_TOKEN"},
+    },
+)
+
+# List all monitors
+monitors = client.monitors.list_monitors()
+
+# Get aggregated results
+results = client.monitors.pull_monitor_results(monitor.monitor_id)
+```
+
+Monitors run jobs on your schedule and send webhook notifications when complete. See the [Monitors documentation](https://www.newscatcherapi.com/docs/v3/catch-all/overview/monitors) for setup and configuration.
+
+## Async client
+
+Use the async client for non-blocking API calls:
+
+```python
+import asyncio
+from newscatcher_catchall import AsyncCatchAllApi
+
+client = AsyncCatchAllApi(api_key="YOUR_API_KEY")
+
+async def main() -> None:
+    job = await client.jobs.create_job(
+        query="Tech company earnings this quarter",
+        context="Focus on revenue and profit margins",
+    )
+    print(f"Job created: {job.job_id}")
+
+asyncio.run(main())
+```
+
+## Exception handling
+
+Handle API errors with the `ApiError` exception:
+
+```python
+from newscatcher_catchall.core.api_error import ApiError
+
+try:
+    client.jobs.create_job(query="...")
+except ApiError as e:
+    print(f"Status: {e.status_code}")
+    print(f"Error: {e.body}")
+```
+
+## Advanced
+
+### Pagination
+
+Retrieve large result sets with pagination:
+
+```python
+results = client.jobs.get_job_results(
+    job_id="...",
+    page=1,
+    page_size=100,  # Default: 100, Max: 1000
+)
+```
+
+### Access raw response data
+
+Access response headers and raw data:
+
+```python
+response = client.jobs.with_raw_response.create_job(query="...")
+print(response.headers)
+print(response.data)
+```
+
+### Retries
+
+The SDK retries failed requests automatically with exponential backoff. Configure retry behavior:
+
+```python
+client.jobs.create_job(
+    query="...",
+    request_options={"max_retries": 3},
+)
+```
+
+### Timeouts
+
+Set custom timeouts at the client or request level:
+
+```python
+# Client-level timeout
+client = CatchAllApi(api_key="YOUR_API_KEY", timeout=30.0)
+
+# Request-level timeout
+client.jobs.create_job(
+    query="...",
+    request_options={"timeout_in_seconds": 10},
+)
+```
+
+### Custom HTTP client
+
+Customize the underlying HTTP client for proxies or custom transports:
+
+```python
+import httpx
+from newscatcher_catchall import CatchAllApi
+
+client = CatchAllApi(
+    api_key="YOUR_API_KEY",
+    httpx_client=httpx.Client(
+        proxy="http://my.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta status
+
+CatchAll API is in beta. Breaking changes may occur in minor version updates. See the [Changelog](https://www.newscatcherapi.com/docs/v3/catch-all/overview/changelog) for updates.
+
+## Contributing
+
+This library is generated programmatically from our API specification. Direct contributions to the generated code cannot be merged, but README improvements are welcome. To suggest SDK changes, please [open an issue](https://github.com/Newscatcher/newscatcher-catchall-python/issues).
+
+## Support
+
+- Documentation: [https://www.newscatcherapi.com/docs/v3/catch-all](https://www.newscatcherapi.com/docs/v3/catch-all)
+- Support: <support@newscatcherapi.com>
+

newscatcher_catchall_sdk-0.1.0/README.md

@@ -0,0 +1,194 @@
+# Newscatcher CatchAll 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%2FNewscatcher%2Fnewscatcher-catchall-python)
+[![pypi](https://img.shields.io/pypi/v/newscatcher-catchall-sdk)](https://pypi.python.org/pypi/newscatcher-catchall-sdk)
+
+The Newscatcher CatchAll Python library provides access to the [CatchAll API](https://www.newscatcherapi.com/docs/v3/catch-all/overview/introduction), which transforms natural language queries into structured data extracted from web sources.
+
+## Installation
+
+```sh
+pip install newscatcher-catchall-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+### Jobs
+
+Submit a query and retrieve structured results:
+
+```python
+from newscatcher_catchall import CatchAllApi
+import time
+
+client = CatchAllApi(api_key="YOUR_API_KEY")
+
+# Create a job
+job = client.jobs.create_job(
+    query="Tech company earnings this quarter",
+    context="Focus on revenue and profit margins",
+    schema="Company [NAME] earned [REVENUE] in [QUARTER]",
+)
+
+# Poll for completion
+while True:
+    status = client.jobs.get_job_status(job.job_id)
+    if status.status == "job_completed":
+        break
+    time.sleep(60)
+
+# Retrieve results
+results = client.jobs.get_job_results(job.job_id)
+for record in results.all_records:
+    print(record.record_title)
+    print(record.enrichment)
+```
+
+Jobs process asynchronously and typically complete in 10-15 minutes. To learn more, see the [Quickstart](https://www.newscatcherapi.com/docs/v3/catch-all/overview/quickstart).
+
+### Monitors
+
+Automate recurring queries with scheduled execution:
+
+```python
+from newscatcher_catchall import CatchAllApi
+
+client = CatchAllApi(api_key="YOUR_API_KEY")
+
+# Create a monitor from a completed job
+monitor = client.monitors.create_monitor(
+    reference_job_id=job.job_id,
+    schedule="every day at 12 PM UTC",
+    webhook={
+        "url": "https://your-endpoint.com/webhook",
+        "method": "POST",
+        "headers": {"Authorization": "Bearer YOUR_TOKEN"},
+    },
+)
+
+# List all monitors
+monitors = client.monitors.list_monitors()
+
+# Get aggregated results
+results = client.monitors.pull_monitor_results(monitor.monitor_id)
+```
+
+Monitors run jobs on your schedule and send webhook notifications when complete. See the [Monitors documentation](https://www.newscatcherapi.com/docs/v3/catch-all/overview/monitors) for setup and configuration.
+
+## Async client
+
+Use the async client for non-blocking API calls:
+
+```python
+import asyncio
+from newscatcher_catchall import AsyncCatchAllApi
+
+client = AsyncCatchAllApi(api_key="YOUR_API_KEY")
+
+async def main() -> None:
+    job = await client.jobs.create_job(
+        query="Tech company earnings this quarter",
+        context="Focus on revenue and profit margins",
+    )
+    print(f"Job created: {job.job_id}")
+
+asyncio.run(main())
+```
+
+## Exception handling
+
+Handle API errors with the `ApiError` exception:
+
+```python
+from newscatcher_catchall.core.api_error import ApiError
+
+try:
+    client.jobs.create_job(query="...")
+except ApiError as e:
+    print(f"Status: {e.status_code}")
+    print(f"Error: {e.body}")
+```
+
+## Advanced
+
+### Pagination
+
+Retrieve large result sets with pagination:
+
+```python
+results = client.jobs.get_job_results(
+    job_id="...",
+    page=1,
+    page_size=100,  # Default: 100, Max: 1000
+)
+```
+
+### Access raw response data
+
+Access response headers and raw data:
+
+```python
+response = client.jobs.with_raw_response.create_job(query="...")
+print(response.headers)
+print(response.data)
+```
+
+### Retries
+
+The SDK retries failed requests automatically with exponential backoff. Configure retry behavior:
+
+```python
+client.jobs.create_job(
+    query="...",
+    request_options={"max_retries": 3},
+)
+```
+
+### Timeouts
+
+Set custom timeouts at the client or request level:
+
+```python
+# Client-level timeout
+client = CatchAllApi(api_key="YOUR_API_KEY", timeout=30.0)
+
+# Request-level timeout
+client.jobs.create_job(
+    query="...",
+    request_options={"timeout_in_seconds": 10},
+)
+```
+
+### Custom HTTP client
+
+Customize the underlying HTTP client for proxies or custom transports:
+
+```python
+import httpx
+from newscatcher_catchall import CatchAllApi
+
+client = CatchAllApi(
+    api_key="YOUR_API_KEY",
+    httpx_client=httpx.Client(
+        proxy="http://my.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta status
+
+CatchAll API is in beta. Breaking changes may occur in minor version updates. See the [Changelog](https://www.newscatcherapi.com/docs/v3/catch-all/overview/changelog) for updates.
+
+## Contributing
+
+This library is generated programmatically from our API specification. Direct contributions to the generated code cannot be merged, but README improvements are welcome. To suggest SDK changes, please [open an issue](https://github.com/Newscatcher/newscatcher-catchall-python/issues).
+
+## Support
+
+- Documentation: [https://www.newscatcherapi.com/docs/v3/catch-all](https://www.newscatcherapi.com/docs/v3/catch-all)
+- Support: <support@newscatcherapi.com>

newscatcher_catchall_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "newscatcher-catchall-sdk"
+
+[tool.poetry]
+name = "newscatcher-catchall-sdk"
+version = "0.1.0"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+license = "MIT"
+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",
+    "License :: OSI Approved :: MIT License"
+]
+packages = [
+    { include = "newscatcher_catchall", from = "src"}
+]
+
+[tool.poetry.urls]
+Repository = 'https://github.com/Newscatcher/newscatcher-catchall-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.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

newscatcher_catchall_sdk-0.1.0/src/newscatcher_catchall/__init__.py

@@ -0,0 +1,149 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        Citation,
+        Context,
+        CreateMonitorResponseDto,
+        Error,
+        JobStatus,
+        ListMonitorsResponseDto,
+        ListUserJobsResponseDto,
+        MonitorJobItem,
+        MonitorListItem,
+        PullJobResponseDto,
+        PullJobResponseDtoDateRange,
+        PullMonitorResponseDto,
+        PullMonitorResponseDtoDateRange,
+        PullMonitorResponseDtoReferenceJob,
+        Query,
+        Record,
+        Schema,
+        StatusResponseDto,
+        SubmitResponseBody,
+        ValidationErrorDetail,
+        ValidationErrorDetailLocItem,
+        ValidationErrorResponse,
+        WebhookDto,
+        WebhookDtoMethod,
+        WebhookPayload,
+    )
+    from .errors import ForbiddenError, NotFoundError, UnprocessableEntityError
+    from . import jobs, meta, monitors
+    from .client import AsyncCatchAllApi, CatchAllApi
+    from .environment import CatchAllApiEnvironment
+    from .meta import GetVersionResponse, HealthCheckResponse
+    from .monitors import DisableMonitorResponse, EnableMonitorResponse, ListMonitorJobsRequestSort
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncCatchAllApi": ".client",
+    "CatchAllApi": ".client",
+    "CatchAllApiEnvironment": ".environment",
+    "Citation": ".types",
+    "Context": ".types",
+    "CreateMonitorResponseDto": ".types",
+    "DisableMonitorResponse": ".monitors",
+    "EnableMonitorResponse": ".monitors",
+    "Error": ".types",
+    "ForbiddenError": ".errors",
+    "GetVersionResponse": ".meta",
+    "HealthCheckResponse": ".meta",
+    "JobStatus": ".types",
+    "ListMonitorJobsRequestSort": ".monitors",
+    "ListMonitorsResponseDto": ".types",
+    "ListUserJobsResponseDto": ".types",
+    "MonitorJobItem": ".types",
+    "MonitorListItem": ".types",
+    "NotFoundError": ".errors",
+    "PullJobResponseDto": ".types",
+    "PullJobResponseDtoDateRange": ".types",
+    "PullMonitorResponseDto": ".types",
+    "PullMonitorResponseDtoDateRange": ".types",
+    "PullMonitorResponseDtoReferenceJob": ".types",
+    "Query": ".types",
+    "Record": ".types",
+    "Schema": ".types",
+    "StatusResponseDto": ".types",
+    "SubmitResponseBody": ".types",
+    "UnprocessableEntityError": ".errors",
+    "ValidationErrorDetail": ".types",
+    "ValidationErrorDetailLocItem": ".types",
+    "ValidationErrorResponse": ".types",
+    "WebhookDto": ".types",
+    "WebhookDtoMethod": ".types",
+    "WebhookPayload": ".types",
+    "__version__": ".version",
+    "jobs": ".jobs",
+    "meta": ".meta",
+    "monitors": ".monitors",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncCatchAllApi",
+    "CatchAllApi",
+    "CatchAllApiEnvironment",
+    "Citation",
+    "Context",
+    "CreateMonitorResponseDto",
+    "DisableMonitorResponse",
+    "EnableMonitorResponse",
+    "Error",
+    "ForbiddenError",
+    "GetVersionResponse",
+    "HealthCheckResponse",
+    "JobStatus",
+    "ListMonitorJobsRequestSort",
+    "ListMonitorsResponseDto",
+    "ListUserJobsResponseDto",
+    "MonitorJobItem",
+    "MonitorListItem",
+    "NotFoundError",
+    "PullJobResponseDto",
+    "PullJobResponseDtoDateRange",
+    "PullMonitorResponseDto",
+    "PullMonitorResponseDtoDateRange",
+    "PullMonitorResponseDtoReferenceJob",
+    "Query",
+    "Record",
+    "Schema",
+    "StatusResponseDto",
+    "SubmitResponseBody",
+    "UnprocessableEntityError",
+    "ValidationErrorDetail",
+    "ValidationErrorDetailLocItem",
+    "ValidationErrorResponse",
+    "WebhookDto",
+    "WebhookDtoMethod",
+    "WebhookPayload",
+    "__version__",
+    "jobs",
+    "meta",
+    "monitors",
+]