Sparky: Python Client For Daaily Services

This package ought to include all clients of the services provided by Daaily. We will start with the lucy client. This will be a rapper around the lucy service. Based on HTTP requests.

Official Documentation: DaailyAPIs Python Client Documentation

Installation

Requires local python version: ">=3.10"

Latest unstable release:

pip install git+ssh://git@github.com/DAAily/daailyapis-python-client.git

Latest stable release:

pip install git+ssh://github.com/DAAily/daailyapis-python-client.git@v1.13.11#egg=daaily

In case you want to work with the score client you need to install additional dependencies:

pip install git+ssh://github.com/DAAily/daailyapis-python-client.git@v1.13.11#egg=daaily[score]

Usage

For usage please have a look at the samples part of the samples readme file: SAMPLES.md

Development

Install Extra Dependencies

python -m venv venv
venv/bin/activate
pip install -e ".[score]"

Run Tests

python -m venv venv
venv/bin/activate
cp .env.example .env
pip install -r tests/requirements.txt

Push New Version

Increment version by doing the following steps (ensure you have gcloud installed and authenticated):

• Manually increment the version in daaily/version.py. Check the naming convention at https://github.com/DAAily/daailyapis-python-client/releases
• Merge the new changes (including the version increment) into the main branch (production).
• Run the following:

source venv/bin/activate
pip install keyrings.google-artifactregistry-auth
pip install build
pip install twine
python -m build
python -m twine upload --repository-url https://europe-west3-python.pkg.dev/one-data-project/daailyapis-python-client/ dist/* --skip-existing

Logging Configuration

The Lucy client uses Python's built-in logging module for internal logging. By default, logging is disabled to avoid cluttering your application logs. To enable logging, you have multiple options:

• Simple logging activation: You can easily activate logging by setting the optional log_level parameter when creating a Client instance:

from lucy import Client
import logging

client = Client(log_level=logging.INFO)

This provides convenient and immediate logging setup using sensible defaults.

• Explicit logging configuration: For more control, you can configure logging explicitly within your application. This overrides the client's basic logging setup:

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format="%(asctime)s [%(levelname)s] %(name)s: %(message)s",
    handlers=[logging.StreamHandler()]
)

# Now instantiate the client without the log_level parameter
from lucy import Client
client = Client()

• Library default: If neither of these methods is used, the client remains silent due to the default NullHandler configuration, ensuring no unwanted logging output.

We recommend explicit configuration for production environments, as it offers the greatest flexibility. The convenient log_level parameter is ideal for development and debugging.