Metadata-Version: 2.4
Name: pyclicky
Version: 0.1.1
Summary: An asynchronous Python client for the Clicky Analytics API.
Author-email: avclicky <pyclicky@getclicky.com>
License: Apache-2.0
Project-URL: Homepage, https://github.com/avclicky/pyclicky
Project-URL: Documentation, https://github.com/avclicky/pyclicky
Project-URL: Repository, https://github.com/avclicky/pyclicky
Keywords: clicky,analytics,api,asyncio,aiohttp
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.9
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Requires-Dist: python-dotenv; extra == "test"
Dynamic: license-file

# pyclicky

Async Python client for the Clicky Analytics API.

## Installation

```bash
pip install pyclicky
```

## Example

```python
import asyncio
from pyclicky import ClickyClient

async def main():
    async with ClickyClient(
        site_id=12345,
        sitekey="your_sitekey",
    ) as client:

        visitors = await client.visitors(date="today")
        print(visitors)

asyncio.run(main())
```

## Generic Queries

```python
await client.query(
    "pages",
    date="last-30-days",
    limit=25,
)
```

Supports every Clicky report type via `query()`.

## Development environment

```sh
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
python -m pip install --upgrade pip
python -m pip install -e .

# Run pre-commit
python -m pip install pre-commit
pre-commit install
pre-commit run --all-files

# Run tests
python -m pip install -e ".[test]"
pytest

# Build package
python -m pip install build
python -m build
```
