Metadata-Version: 2.1
Name: lightdash-client-python
Version: 0.621.0
Summary: A client library for accessing Lightdash API 
Author: yu-iskw
Requires-Python: >=3.8.0,<4
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Typing :: Typed
Requires-Dist: httpx >= 0.15.0, < 0.25.0
Requires-Dist: attrs >= 21.3.0
Requires-Dist: python-dateutil >= 2.8.0, < 3
Requires-Dist: flit ==3.7.1 ; extra == "dev"
Requires-Dist: build ==0.7.0 ; extra == "dev"
Requires-Dist: yapf >=0.29.0 ; extra == "dev"
Requires-Dist: pyyaml >=5.3 ; extra == "dev"
Requires-Dist: pdoc3 >=0.9.2 ; extra == "dev"
Requires-Dist: pre-commit >=2.15.0 ; extra == "dev"
Requires-Dist: openapi-python-client >=0.14,<1.0 ; extra == "dev"
Requires-Dist: pytest >=6.2.4,<7.0.0 ; extra == "test"
Requires-Dist: pylint >=2.12.0 ; extra == "test"
Requires-Dist: mypy >=0.910,<1.0 ; extra == "test"
Requires-Dist: flake8 >=3.8.3,<4.0.0 ; extra == "test"
Requires-Dist: black >=20.0 ; extra == "test"
Requires-Dist: isort >=5.0.6,<6.0.0 ; extra == "test"
Requires-Dist: yapf >=0.29.0 ; extra == "test"
Project-URL: Home, https://github.com/yu-iskw/lightdash-client-python
Provides-Extra: dev
Provides-Extra: test

# lightdash-client-python
A client library for accessing Lightdash API

## Usage
First, create a client:

```python
from lightdash_client import Client

client = Client(base_url="https://api.example.com")
```

If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:

```python
from lightdash_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
```

Now call your endpoint and use your models:

```python
from lightdash_client.models import MyDataModel
from lightdash_client.api.my_tag import get_my_data_model
from lightdash_client.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
```

Or do the same thing with an async version:

```python
from lightdash_client.models import MyDataModel
from lightdash_client.api.my_tag import get_my_data_model
from lightdash_client.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
```

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

```python
client = AuthenticatedClient(
    base_url="https://internal_api.example.com",
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)
```

You can also disable certificate validation altogether, but beware that **this is a security risk**.

```python
client = AuthenticatedClient(
    base_url="https://internal_api.example.com",
    token="SuperSecretToken",
    verify_ssl=False
)
```

There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info.

Things to know:
1. Every path/method combo becomes a Python module with four functions:
    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
    1. `asyncio`: Like `sync` but async instead of blocking
    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking

1. All path/query params, and bodies become method arguments.
1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
1. Any endpoint which did not have a tag will be in `lightdash_client.api.default`


### Example: Get dashboards in a project
Here is an example to get all dashboards in a project.

```python
from lightdash_client import AuthenticatedClient
from lightdash_client.api.dashboard import get_dashboards

api_key = "..."
project_uuid = "..."

client = AuthenticatedClient(base_url="https://app.lightdash.cloud/api/v1", token=api_key)

dashboards = get_dashboards.sync(client=client, project_uuid=project_uuid)
print(dashboards)
```

