Skip to main content

ApertureDB Python SDK

Project description

ApertureDB Client Python Module

This is the python sdk for building applications with ApertureDB.

This comprises of utilities to get Data in and out of ApertureDB in an optimal manner. A quick getting started guide is useful to start building with this sdk. For more concrete examples, please refer to:

Installing in a custom virtual enviroment.

pip install aperturedb[complete]

or an installation with only the core part of the SDK

pip install aperturedb

A complete reference of this SDK is available on the offical ApertureDB Documentation

Dvelopment setup.

The recommended way is to clone this repo, and do an editable install as follows:

git clone https://github.com/aperture-data/aperturedb-python.git
cd aperturedb-python
pip install -e .[dev]

Running tests.

The tests are inside the test dir.

All the tests can be run with:

bash run_test.sh

Running specefic tests can be accomplished by invoking it with pytest as follows:

cd test && docker compose up -d && PROJECT=aperturedata KAGGLE_username=ci KAGGLE_key=dummy coverage run -m python -m pytest test_Session.py -v --log-cli-level=DEBUG

Reporting bugs.

Any error in the functionality / documentation / tests maybe reported by creating a github issue.

Development guidelines.

For inclusion of any features, a PR may be created with a patch, and a brief description of the problem and the fix. The CI enforces a coding style guideline with autopep8 and a script to detect trailing white spaces.

In case a PR encounters failures, the log would describe the location of the offending line with a description of the problem.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aperturedb-0.4.23.tar.gz (103.0 kB view hashes)

Uploaded Source

Built Distribution

aperturedb-0.4.23-py3-none-any.whl (115.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page