mot-history-api-py-sdk
======================
.. image:: https://badge.fury.io/py/mot-history-api-py-sdk.svg
:target: https://badge.fury.io/py/mot-history-api-py-sdk
:alt: MOT History API Python SDK
The SDK provides convenient access to the `MOT History API`_ functionality from applications written in the Python programming language.
.. _MOT History API: https://documentation.history.mot.api.gov.uk/
Requirements
------------
Python 2.7 and later.
Setup
------
You can install this package by using the pip tool and installing:
.. code-block:: bash
pip install mot-history-api-py-sdk
Or:
.. code-block:: bash
easy_install mot-history-api-py-sdk
Install from source with:
.. code-block:: bash
python setup.py install --user
Or, `sudo python setup.py install` to install the package for all users.
Tests
------
Export environment variables:
.. code-block:: bash
export MOT_CLIENT_ID=
export MOT_CLIENT_SECRET=
export MOT_API_KEY=
Now, you can execute this command: `python3 -m test`
Unset the environment variables after completing the tests:
.. code-block:: bash
unset MOT_CLIENT_ID && unset MOT_CLIENT_SECRET && unset MOT_API_KEY
Developers/Engineers can run tests in two scenarios:
+ **With real credentials**: They set the environment variables, and the tests use the live API connection.
+ **Without credentials**: The tests run using a mock client, allowing basic functionality checks without a live API connection.
The flexibility supports real integration testing and quick, credential-free checks during development.
Request MOT History API Key
---------------------------
You can use this support form to request an `API Key`_.
.. _API Key: https://documentation.history.mot.api.gov.uk/mot-history-api/register
Using the MOT History API Key
-----------------------------
You can read the `API documentation`_ to understand what's possible with MOT History API Key. If you need further assistance, don't hesitate to `contact the DVSA`_.
.. _API documentation: https://documentation.history.mot.api.gov.uk/
.. _contact the DVSA: https://documentation.history.mot.api.gov.uk/mot-history-api/support
License
--------
This project is licensed under the `MIT License`_.
.. _MIT License: https://gist.github.com/0xnu/d11da49c85eeb7272517a9010bbdf1ab
Copyright
---------
Copyright |copy| 2023 - 2024 `Finbarrs Oketunji`_.
The MOT History API Python SDK is Licensed under the `Open Government Licence v3.0`_
.. |copy| unicode:: 0xA9 .. copyright sign
.. _Finbarrs Oketunji: https://finbarrs.eu
.. _Open Government Licence v3.0: https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
Raw data
{
"_id": null,
"home_page": "https://documentation.history.mot.api.gov.uk/",
"name": "mot-history-api-py-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"maintainer_email": null,
"keywords": "dvsa, gov, uk, mot, hgv, psv, vehicle, registration, results",
"author": "Finbarrs Oketunji",
"author_email": "f@finbarrs.eu",
"download_url": "https://files.pythonhosted.org/packages/04/fd/02dfefa69e1a3ad5e934de4258b3243d716a0008de16a9f10192ad14235b/mot-history-api-py-sdk-1.0.1.tar.gz",
"platform": null,
"description": "mot-history-api-py-sdk\n======================\n\n.. image:: https://badge.fury.io/py/mot-history-api-py-sdk.svg\n :target: https://badge.fury.io/py/mot-history-api-py-sdk\n :alt: MOT History API Python SDK\n\nThe SDK provides convenient access to the `MOT History API`_ functionality from applications written in the Python programming language.\n\n.. _MOT History API: https://documentation.history.mot.api.gov.uk/\n\n\nRequirements\n------------\n\nPython 2.7 and later.\n\n\nSetup\n------\n\nYou can install this package by using the pip tool and installing:\n\n.. code-block:: bash\n\n\tpip install mot-history-api-py-sdk\n\nOr:\n\n.. code-block:: bash\n\n\teasy_install mot-history-api-py-sdk\n\nInstall from source with:\n\n.. code-block:: bash\n\n python setup.py install --user\n\nOr, `sudo python setup.py install` to install the package for all users.\n\nTests\n------\n\nExport environment variables:\n\n.. code-block:: bash\n\n export MOT_CLIENT_ID=\n export MOT_CLIENT_SECRET=\n export MOT_API_KEY=\n\nNow, you can execute this command: `python3 -m test`\n\nUnset the environment variables after completing the tests:\n\n.. code-block:: bash\n\n unset MOT_CLIENT_ID && unset MOT_CLIENT_SECRET && unset MOT_API_KEY\n\nDevelopers/Engineers can run tests in two scenarios:\n\n+ **With real credentials**: They set the environment variables, and the tests use the live API connection.\n\n+ **Without credentials**: The tests run using a mock client, allowing basic functionality checks without a live API connection.\n\nThe flexibility supports real integration testing and quick, credential-free checks during development.\n\nRequest MOT History API Key\n---------------------------\n\nYou can use this support form to request an `API Key`_.\n\n.. _API Key: https://documentation.history.mot.api.gov.uk/mot-history-api/register\n\n\nUsing the MOT History API Key\n-----------------------------\n\nYou can read the `API documentation`_ to understand what's possible with MOT History API Key. If you need further assistance, don't hesitate to `contact the DVSA`_.\n\n.. _API documentation: https://documentation.history.mot.api.gov.uk/\n.. _contact the DVSA: https://documentation.history.mot.api.gov.uk/mot-history-api/support\n\nLicense\n--------\n\nThis project is licensed under the `MIT License`_.\n\n.. _MIT License: https://gist.github.com/0xnu/d11da49c85eeb7272517a9010bbdf1ab\n\n\nCopyright\n---------\n\nCopyright |copy| 2023 - 2024 `Finbarrs Oketunji`_.\n\nThe MOT History API Python SDK is Licensed under the `Open Government Licence v3.0`_\n\n.. |copy| unicode:: 0xA9 .. copyright sign\n.. _Finbarrs Oketunji: https://finbarrs.eu\n.. _Open Government Licence v3.0: https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The SDK provides convenient access to the MOT History API for applications written in the Python programming language.",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/0xnu/mot-history-api-sdk/issues",
"Changes": "https://github.com/0xnu/mot-history-api-sdk/blob/main/CHANGELOG.md",
"Documentation": "https://documentation.history.mot.api.gov.uk/",
"Homepage": "https://documentation.history.mot.api.gov.uk/",
"Source Code": "https://github.com/0xnu/mot-history-api-sdk"
},
"split_keywords": [
"dvsa",
" gov",
" uk",
" mot",
" hgv",
" psv",
" vehicle",
" registration",
" results"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6dca614f2efc3ca500650908b677bc6d52ff943a0397ca485250568f77a51e66",
"md5": "0b154e140d14ef1bc45c52d1cae99be8",
"sha256": "61b8e3bfd2f14ddbc7c33efcefd2b449d794fddbe918126bda0ea7d9addb501b"
},
"downloads": -1,
"filename": "mot_history_api_py_sdk-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b154e140d14ef1bc45c52d1cae99be8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 5577,
"upload_time": "2024-09-21T20:50:27",
"upload_time_iso_8601": "2024-09-21T20:50:27.470267Z",
"url": "https://files.pythonhosted.org/packages/6d/ca/614f2efc3ca500650908b677bc6d52ff943a0397ca485250568f77a51e66/mot_history_api_py_sdk-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04fd02dfefa69e1a3ad5e934de4258b3243d716a0008de16a9f10192ad14235b",
"md5": "e9b6423960ed90fa8fbd9fe4bd234296",
"sha256": "295a63c0059db11a0bc1983270867f965a4247addc048cfea8f034d33997ca22"
},
"downloads": -1,
"filename": "mot-history-api-py-sdk-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e9b6423960ed90fa8fbd9fe4bd234296",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 5155,
"upload_time": "2024-09-21T20:50:28",
"upload_time_iso_8601": "2024-09-21T20:50:28.836384Z",
"url": "https://files.pythonhosted.org/packages/04/fd/02dfefa69e1a3ad5e934de4258b3243d716a0008de16a9f10192ad14235b/mot-history-api-py-sdk-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-21 20:50:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "0xnu",
"github_project": "mot-history-api-sdk",
"github_not_found": true,
"lcname": "mot-history-api-py-sdk"
}
JSON
