fathom-python 0.0.23__tar.gz

fathom_python-0.0.23/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.1
+Name: fathom-python
+Version: 0.0.23
+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: svix (==1.65.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Fathom 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%2Ffathom-video%2Ffathom-python)
+[![pypi](https://img.shields.io/pypi/v/fathom)](https://pypi.python.org/pypi/fathom)
+
+The Fathom Python library provides convenient access to the Fathom API from Python.
+
+## Installation
+
+```sh
+pip install fathom
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from fathom import FathomApi
+client = FathomApi(api_key="YOUR_API_KEY", )
+client.list_meetings()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+from fathom import AsyncFathomApi
+import asyncio
+client = AsyncFathomApi(api_key="YOUR_API_KEY", )
+async def main() -> None:
+    await client.list_meetings()
+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 fathom.core.api_error import ApiError
+try:
+    client.list_meetings(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from fathom import FathomApi
+client = FathomApi(..., )
+response = client.with_raw_response.list_meetings(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable 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.list_meetings(..., 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 fathom import FathomApi
+client = FathomApi(..., timeout=20.0, )
+
+# Override timeout for a specific method
+client.list_meetings(..., 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
+from fathom import FathomApi
+import httpx
+client = FathomApi(..., 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!
+

fathom_python-0.0.23/README.md

@@ -0,0 +1,123 @@
+# Fathom 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%2Ffathom-video%2Ffathom-python)
+[![pypi](https://img.shields.io/pypi/v/fathom)](https://pypi.python.org/pypi/fathom)
+
+The Fathom Python library provides convenient access to the Fathom API from Python.
+
+## Installation
+
+```sh
+pip install fathom
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from fathom import FathomApi
+client = FathomApi(api_key="YOUR_API_KEY", )
+client.list_meetings()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+from fathom import AsyncFathomApi
+import asyncio
+client = AsyncFathomApi(api_key="YOUR_API_KEY", )
+async def main() -> None:
+    await client.list_meetings()
+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 fathom.core.api_error import ApiError
+try:
+    client.list_meetings(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from fathom import FathomApi
+client = FathomApi(..., )
+response = client.with_raw_response.list_meetings(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable 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.list_meetings(..., 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 fathom import FathomApi
+client = FathomApi(..., timeout=20.0, )
+
+# Override timeout for a specific method
+client.list_meetings(..., 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
+from fathom import FathomApi
+import httpx
+client = FathomApi(..., 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!

fathom_python-0.0.23/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "fathom-python"
+
+[tool.poetry]
+name = "fathom-python"
+version = "0.0.23"
+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 = "fathom", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/fathom-video/fathom-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
+svix = "1.65.0"
+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"

fathom_python-0.0.23/src/fathom/__init__.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .types import (
+    ActionItem,
+    Assignee,
+    CrmCompanyMatch,
+    CrmContactMatch,
+    CrmDealMatch,
+    CrmMatches,
+    FathomUser,
+    Invitee,
+    ListMeetingsRequestMeetingType,
+    Meeting,
+    MeetingListResponse,
+    MeetingMeetingType,
+    MeetingSummary,
+    Team,
+    TeamListResponse,
+    TeamMember,
+    TeamMemberListResponse,
+    TranscriptItem,
+    TranscriptItemSpeaker,
+)
+from .errors import BadRequestError, UnauthorizedError
+from .client import AsyncFathomApi, FathomApi
+from .environment import ClientEnvironment
+from .version import __version__
+
+__all__ = [
+    "ActionItem",
+    "Assignee",
+    "AsyncFathomApi",
+    "BadRequestError",
+    "FathomApi",
+    "ClientEnvironment",
+    "CrmCompanyMatch",
+    "CrmContactMatch",
+    "CrmDealMatch",
+    "CrmMatches",
+    "FathomUser",
+    "Invitee",
+    "ListMeetingsRequestMeetingType",
+    "Meeting",
+    "MeetingListResponse",
+    "MeetingMeetingType",
+    "MeetingSummary",
+    "Team",
+    "TeamListResponse",
+    "TeamMember",
+    "TeamMemberListResponse",
+    "TranscriptItem",
+    "TranscriptItemSpeaker",
+    "UnauthorizedError",
+    "__version__",
+]