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.
Raw data
{
"_id": null,
"home_page": "https://github.com/Mopinion-com/mopinion-python-api",
"name": "mopinion",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "mopinion",
"author": "Mopinion",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/18/67/fad826e60e03992f05a35941458c8eabd736762ea4480a75fb04c69ee994/mopinion-1.0.1.tar.gz",
"platform": null,
"description": "Mopinion API - Python Client\n==========================================\n\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://github.com/Mopinion-com/mopinion-python-api/blob/master/LICENSE\n :alt: License-MIT\n\n.. image:: https://readthedocs.org/projects/mopinion-python-api/badge/?version=latest\n :target: https://mopinion-python-api.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://github.com/Mopinion-com/mopinion-python-api/workflows/Test%20Suite/badge.svg/\n :alt: GitHub Actions\n\n.. image:: https://badge.fury.io/py/mopinion.svg/\n :target: https://badge.fury.io/py/mopinion/\n :alt: Badge PyPi\n\n\nA client library for the `Mopinion Data API <https://developer.mopinion.com/api/>`_.\n\nOur Mopinion Client provides functionality for authentication, authorization and requesting resources.\nIt comes with an easy, beautiful, and elegant way of interacting with our API.\n\n`Read the docs <https://mopinion-python-api.readthedocs.io/en/latest/>`_ for further information.\n\nInstallation\n-------------\n\nInstall using ``pip``::\n\n pip install mopinion\n\n\nExample\n--------\n\n.. code:: python\n\n >>> from mopinion import MopinionClient\n >>> client = MopinionClient(public_key=PUBLIC_KEY, private_key=PRIVATE_KEY)\n >>> assert client.is_available()\n >>> response = client.resource(\"account\")\n >>> response = client.resource(\"deployments\")\n >>>\n >>> response = client.get_account()\n >>>\n >>> response = client.get_deployments()\n >>> response = client.get_deployments(\"abc\")\n >>>\n >>> response = client.get_reports(report_id=123)\n >>> response = client.get_reports_fields(report_id=123)\n >>> response = client.get_reports_feedback(report_id=123)\n >>>\n >>> response = client.get_datasets(dataset_id=123)\n >>> response = client.get_datasets_feedback(dataset_id=123)\n >>> response = client.get_datasets_fields(dataset_id=123)\n >>>\n >>> client.close()\n >>>\n >>> with MopinionClient(public_key=YOUR_PUBLIC_KEY, private_key=YOUR_PRIVATE_KEY) as client:\n ... response = client.get_account()\n ... assert response.json()[\"_meta\"][\"code\"] == 200\n\nDocumentation\n---------------\n\nYou can find here at `Read the docs <https://mopinion-python-api.readthedocs.io/en/latest/>`_ the complete documentation.\n\n\nAbout Mopinion\n---------------\n\n`Mopinion <https://mopinion.com/>`_ is a leading all-in-one user feedback platform that helps digital enterprises listen, understand,\nand act across all digital touchpoints (web, mobile, and email). Join some of the most forward-thinking\ndigital teams from companies such as T-mobile, eBay, TSB Bank, Walmart, Hotels.com, Decathlon, Ahold,\nMediacorp Ltd, and many more.\n\nPlease visit the website for more information about the product: https://mopinion.com\n\n\nChangelog\n========================================================\n\n\n1.0.1 (2023-07-11)\n-------------------\n- Fix issue where query parameters are not properly set for iterable responses.\n\n1.0.0 (2022-03-04)\n-------------------\n\n- Released stable version.\n\n\n0.0.7 (2022-02-23)\n-------------------\n\n- Fixes in documentation.\n\n- Implement `__enter__()` and `__exit__()` methods.\n\n- Added methods: `get_account`, `get_deployments`,\n `get_datasets`, `get_datasets_fields`,\n `get_datasets_feedback`, `get_reports`,\n `get_reports_fields`, `get_reports_feedback`.\n\n- Increased compatibility from Python 3.6 to 3.10.\n\n\n0.0.6 (2021-02-11)\n-------------------\n\n- Fixes in documentation.\n\n- Added pre-commit configuration to project.\n\n- Added new endpoint for `/deployments/<str_id>`.\n\n\n0.0.5 (2021-01-22)\n-------------------\n\n- Several fixes in documentation.\n\n\n0.0.4 (2021-01-22)\n-------------------\n\n- Fixed in documentation.\n\n- Added examples for `query_params` in the doc examples.\n\n- Updated directory name from `mopinion_client` to `mopinion`.\n\n- Implemented About in Docs and Readme.\n\n0.0.3 (2021-01-20)\n-------------------\n\n- Fixed typing in method `get_token`. Return `bytes` instead of `str`.\n\n0.0.2 (2021-01-20)\n-------------------\n\n- Fixed in documentation.\n\n- Removed travis ci. Integrated GitHub Actions.\n\n- Added coverage into GitHub actions.\n\n0.0.1 (2021-01-20)\n-------------------\n\n- Initial project structure.\n\n- Client implementation.\n\n- Test suite.\n\n- Request examples.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A client library for the Mopinion Data API",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/Mopinion-com/mopinion-python-api"
},
"split_keywords": [
"mopinion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb3f67cc73c83fbe538aa4e5f16fc8cedca03388effb2fbcb0b161d231fb1930",
"md5": "266ba75d6536d1f81dca5d0579c26bcf",
"sha256": "c5a021505f82330a3a317a1a7166243c55f36df67137a9dface5299b637e24a7"
},
"downloads": -1,
"filename": "mopinion-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "266ba75d6536d1f81dca5d0579c26bcf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9394,
"upload_time": "2023-07-12T08:02:54",
"upload_time_iso_8601": "2023-07-12T08:02:54.012274Z",
"url": "https://files.pythonhosted.org/packages/cb/3f/67cc73c83fbe538aa4e5f16fc8cedca03388effb2fbcb0b161d231fb1930/mopinion-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1867fad826e60e03992f05a35941458c8eabd736762ea4480a75fb04c69ee994",
"md5": "cbc91d8ae62c1155019d8efb3cd36b98",
"sha256": "9f5bc0a76bfa6c3c9730681a9f8948f087751601c871421d75bec1206e412b0e"
},
"downloads": -1,
"filename": "mopinion-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "cbc91d8ae62c1155019d8efb3cd36b98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 10404,
"upload_time": "2023-07-12T08:02:55",
"upload_time_iso_8601": "2023-07-12T08:02:55.770459Z",
"url": "https://files.pythonhosted.org/packages/18/67/fad826e60e03992f05a35941458c8eabd736762ea4480a75fb04c69ee994/mopinion-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 08:02:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mopinion-com",
"github_project": "mopinion-python-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mopinion"
}
JSON
