Skip to main content

Library for accessing a local nqm-iot-database

Project description

nqm-iot-database-utils-python

Python port of nqminds/nqm-iot-database-utils

Installing

Use the below to install as a library using pip:

pip3 install nqm.iotdatabase
# installing the latest git version:
# pip3 install git+https://github.com/nqminds/nqm-iot-database-py.git#egg=nqm.iotdatabase

You can replace pip3 with poetry if you prefer.

To download the library, install dependencies for running tests, and build documentation, do:

git clone https://github.com/nqminds/nqm-iot-database-py.git
cd nqm-iot-database-py/
poetry install

Documentation

We use Sphinx, Autodoc, Napoleon, and sphinx_autodoc_typehints to make our documentation.

The below creates html.

poetry run make html

Tests

Unittests

poetry run python -m pytest

Unittests Coverage

poetry run coverage run --source=nqm -m pytest && poetry run coverage report

Typetests

poetry run mypy -m nqm.iotdatabase && echo -e "\e[1;32mPass! \e[0m"

Doctests

poetry run make doctest

Linting

poetry run pre-commit run --all-files

Possible upgrades to make in SQLAlchemy

  • Add sorting on Primary Keys (SQLite feature)
  • allow using SQLite URI connections (for read-only)

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

nqm.iotdatabase-1.1.5.tar.gz (21.5 kB view hashes)

Uploaded source

Built Distribution

nqm.iotdatabase-1.1.5-py3-none-any.whl (25.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page