mopinion 1.0.1
A client library for the Mopinion Data API
License: MIT License
Requires Python: >=3.6
Keywords: mopinion

Mopinion API - Python Client
==========================================

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://github.com/Mopinion-com/mopinion-python-api/blob/master/LICENSE
    :alt: License-MIT

.. image:: https://readthedocs.org/projects/mopinion-python-api/badge/?version=latest
    :target: https://mopinion-python-api.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://github.com/Mopinion-com/mopinion-python-api/workflows/Test%20Suite/badge.svg/
    :alt: GitHub Actions

.. image:: https://badge.fury.io/py/mopinion.svg/
    :target: https://badge.fury.io/py/mopinion/
    :alt: Badge PyPi


A client library for the `Mopinion Data API <https://developer.mopinion.com/api/>`_.

Our Mopinion Client provides functionality for authentication, authorization and requesting resources.
It comes with an easy, beautiful, and elegant way of interacting with our API.

`Read the docs <https://mopinion-python-api.readthedocs.io/en/latest/>`_ for further information.

Installation
-------------

Install using ``pip``::

    pip install mopinion


Example
--------

.. code:: python

    >>> from mopinion import MopinionClient
    >>> client = MopinionClient(public_key=PUBLIC_KEY, private_key=PRIVATE_KEY)
    >>> assert client.is_available()
    >>> response = client.resource("account")
    >>> response = client.resource("deployments")
    >>>
    >>> response = client.get_account()
    >>>
    >>> response = client.get_deployments()
    >>> response = client.get_deployments("abc")
    >>>
    >>> response = client.get_reports(report_id=123)
    >>> response = client.get_reports_fields(report_id=123)
    >>> response = client.get_reports_feedback(report_id=123)
    >>>
    >>> response = client.get_datasets(dataset_id=123)
    >>> response = client.get_datasets_feedback(dataset_id=123)
    >>> response = client.get_datasets_fields(dataset_id=123)
    >>>
    >>> client.close()
    >>>
    >>> with MopinionClient(public_key=YOUR_PUBLIC_KEY, private_key=YOUR_PRIVATE_KEY) as client:
    ...     response = client.get_account()
    ...     assert response.json()["_meta"]["code"] == 200

Documentation
---------------

You can find here at `Read the docs <https://mopinion-python-api.readthedocs.io/en/latest/>`_ the complete documentation.


About Mopinion
---------------

`Mopinion <https://mopinion.com/>`_ is a leading all-in-one user feedback platform that helps digital enterprises listen, understand,
and act across all digital touchpoints (web, mobile, and email). Join some of the most forward-thinking
digital teams from companies such as T-mobile, eBay, TSB Bank, Walmart, Hotels.com, Decathlon, Ahold,
Mediacorp Ltd, and many more.

Please visit the website for more information about the product: https://mopinion.com


Changelog
========================================================


1.0.1 (2023-07-11)
-------------------
- Fix issue where query parameters are not properly set for iterable responses.

1.0.0 (2022-03-04)
-------------------

- Released stable version.


0.0.7 (2022-02-23)
-------------------

- Fixes in documentation.

- Implement `__enter__()` and `__exit__()` methods.

- Added methods: `get_account`, `get_deployments`,
  `get_datasets`, `get_datasets_fields`,
  `get_datasets_feedback`, `get_reports`,
  `get_reports_fields`, `get_reports_feedback`.

- Increased compatibility from Python 3.6 to 3.10.


0.0.6 (2021-02-11)
-------------------

- Fixes in documentation.

- Added pre-commit configuration to project.

- Added new endpoint for `/deployments/<str_id>`.


0.0.5 (2021-01-22)
-------------------

- Several fixes in documentation.


0.0.4 (2021-01-22)
-------------------

- Fixed in documentation.

- Added examples for `query_params` in the doc examples.

- Updated directory name from `mopinion_client` to `mopinion`.

- Implemented About in Docs and Readme.

0.0.3 (2021-01-20)
-------------------

- Fixed typing in method `get_token`. Return `bytes` instead of `str`.

0.0.2 (2021-01-20)
-------------------

- Fixed in documentation.

- Removed travis ci. Integrated GitHub Actions.

- Added coverage into GitHub actions.

0.0.1 (2021-01-20)
-------------------

- Initial project structure.

- Client implementation.

- Test suite.

- Request examples.