Metadata-Version: 2.1
Name: dune-client
Version: 1.2.2b0
Summary: A simple framework for interacting with Dune Analytics official API service.
Home-page: https://github.com/cowprotocol/dune-client
Author: Benjamin H. Smith
Author-email: ben@cow.fi
License: Apache License Version 2.0
Project-URL: Tracker, https://github.com/cowprotocol/dune-client/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE
Requires-Dist: aiohttp>=3.8.3
Requires-Dist: types-python-dateutil>=2.8.19
Requires-Dist: types-PyYAML>=6.0.11
Requires-Dist: types-requests>=2.28.9
Requires-Dist: types-Deprecated>=1.2.9.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: requests>=2.28.1
Requires-Dist: ndjson>=0.3.1
Requires-Dist: Deprecated>=1.2.14

# Dune Client

A python framework for interacting with Dune Analytics' [officially supported API
service](https://duneanalytics.notion.site/API-Documentation-1b93d16e0fa941398e15047f643e003a).

## Installation

Import as a project dependency

```shell
pip install dune-client
```

# Example Usage

Export your `DUNE_API_KEY` (or place it in a `.env` file - as in
here [.env.sample](./.env.sample).

```python
from dune_client.types import QueryParameter
from dune_client.client import DuneClient
from dune_client.query import QueryBase

query = QueryBase(
    name="Sample Query",
    query_id=1215383,
    params=[
        QueryParameter.text_type(name="TextField", value="Word"),
        QueryParameter.number_type(name="NumberField", value=3.1415926535),
        QueryParameter.date_type(name="DateField", value="2022-05-04 00:00:00"),
        QueryParameter.enum_type(name="EnumField", value="Option 1"),
    ],
)
print("Results available at", query.url())

dune = DuneClient.from_env()
results = dune.refresh(query)
```

For a more elaborate example,
visit [dune-alerts](https://github.com/cowprotocol/dune-alerts)

