Metadata-Version: 2.4
Name: mass-iq
Version: 1.0.0
Summary: Client package to interact with the massIQ API
License: MIT
Author: Jannick Kappelmann
Author-email: jannick.kappelmann@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: aiohttp (==3.12.15)
Requires-Dist: cachetools (==5.5.2)
Requires-Dist: pydantic-settings (>=2.10.1,<3.0.0)
Requires-Dist: requests (==2.32.4)
Requires-Dist: tenacity (==8.5.0)
Project-URL: Homepage, https://github.com/jannickk/mass-iq
Description-Content-Type: text/markdown

## MassIQ Client package

This python package is a client package for the MassIQ API. The client object is configured exclusively through the environment.
Required environmental variables to configure the API to connect against

    DOMAIN
    SERVICE_PORT

Your authentication credentials are provided by massflows and must be stored in the following environmental variables

    USER_APP_CLIENT_ID
    USER_APP_CLIENT_SECRET


## Dependency Management

This project uses Poetry to manage dependencies and build the python package. In order to use Poetry on Windows
use the installer of Python.org (and not the Windows Store Python Distribution) with the option
"Add Python to PATH" checked. Then install Poetry with Powershell using

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
 
You can run the tests locally by setting the four required environmental variables and run:


    poetry run pytest tests --log-cli-level=INFO

## Compatability

**All dependencies are managed so that they are consistent with the Google Colaboratory Python environment.**



