# django-amiqus
Django app for integration with the Amiqus API.
The current version supports Django 3.2+ and Python 3.10+.
## Background
Amiqus is an online identity verification service. We use this library
to integrate with it.
## Amiqus workflow
There are three core entities that are modelled in this app: `Client`,
`Records`, and `Check` (pending deprecation, and soon to be renamed
`Step`). At a high level they fit together thus:
1. A `Client` represents someone against whom you wish to carry out an
identity or background check. They are unique within Amiqus, although
it's possible to carry out multiple checks over a period of time against
one user.
1. A `Record` is a suite of checks that will have an overall status that
combines the statuses of all the constituent checks.
1. A `Check` / `Step` is an individual check - it could be an identity
check, a facial recognition check, etc. See the API for all details.
### `Client`
An
## Installation
The project is available through PyPI as ``django-amiqus``:
```bash
$ pip install django-amiqus
```
## Tests
If you want to run the tests manually, install ``poetry``.
```bash
$ poetry install
$ poetry run pytest
```
If you are hacking on the project, please keep coverage up.
## Contributing
Standard GH rules apply: clone the repo to your own account, make sure you
update the tests, and submit a pull request.
Raw data
{
"_id": null,
"home_page": "https://github.com/yunojuno/django-amiqus",
"name": "django-amiqus",
"maintainer": "YunoJuno",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "code@yunojuno.com",
"keywords": "",
"author": "YunoJuno",
"author_email": "code@yunojuno.com",
"download_url": "https://files.pythonhosted.org/packages/c8/75/f48259ea2d8bceb3823b3de636058cdcfecfb846cdab111476e95c2e41bd/django_amiqus-0.2.tar.gz",
"platform": null,
"description": "# django-amiqus\n\n\nDjango app for integration with the Amiqus API.\n\nThe current version supports Django 3.2+ and Python 3.10+.\n\n## Background\n\nAmiqus is an online identity verification service. We use this library\nto integrate with it.\n\n## Amiqus workflow\n\nThere are three core entities that are modelled in this app: `Client`,\n`Records`, and `Check` (pending deprecation, and soon to be renamed\n`Step`). At a high level they fit together thus:\n\n1. A `Client` represents someone against whom you wish to carry out an\nidentity or background check. They are unique within Amiqus, although\nit's possible to carry out multiple checks over a period of time against\none user.\n1. A `Record` is a suite of checks that will have an overall status that\ncombines the statuses of all the constituent checks.\n1. A `Check` / `Step` is an individual check - it could be an identity\n check, a facial recognition check, etc. See the API for all details.\n\n### `Client`\n\nAn\n\n\n## Installation\n\nThe project is available through PyPI as ``django-amiqus``:\n\n```bash\n$ pip install django-amiqus\n```\n\n## Tests\n\nIf you want to run the tests manually, install ``poetry``.\n\n```bash\n$ poetry install\n$ poetry run pytest\n```\n\nIf you are hacking on the project, please keep coverage up.\n\n## Contributing\n\nStandard GH rules apply: clone the repo to your own account, make sure you\nupdate the tests, and submit a pull request.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django app for integration with Amiqus.",
"version": "0.2",
"project_urls": {
"Documentation": "https://github.com/yunojuno/django-amiqus",
"Homepage": "https://github.com/yunojuno/django-amiqus",
"Repository": "https://github.com/yunojuno/django-amiqus"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11ce495e0b04dc2b23c90a29e411ed88ca11d5dbdd24eb332281e518fc0b035d",
"md5": "37c53543349c57b1e947708cda935b92",
"sha256": "32adf61070b114bd2683d59ac7178ab4f2777c679582eaac038ebad61789f714"
},
"downloads": -1,
"filename": "django_amiqus-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37c53543349c57b1e947708cda935b92",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 29404,
"upload_time": "2023-11-15T12:14:18",
"upload_time_iso_8601": "2023-11-15T12:14:18.025419Z",
"url": "https://files.pythonhosted.org/packages/11/ce/495e0b04dc2b23c90a29e411ed88ca11d5dbdd24eb332281e518fc0b035d/django_amiqus-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c875f48259ea2d8bceb3823b3de636058cdcfecfb846cdab111476e95c2e41bd",
"md5": "ee420b7031c9870bad6aa7a397c7491f",
"sha256": "96d2f14f3dc7ee0c38513d2a910a841f9fcd4576616115a16faf0c1de0f4b261"
},
"downloads": -1,
"filename": "django_amiqus-0.2.tar.gz",
"has_sig": false,
"md5_digest": "ee420b7031c9870bad6aa7a397c7491f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 21638,
"upload_time": "2023-11-15T12:14:19",
"upload_time_iso_8601": "2023-11-15T12:14:19.525813Z",
"url": "https://files.pythonhosted.org/packages/c8/75/f48259ea2d8bceb3823b3de636058cdcfecfb846cdab111476e95c2e41bd/django_amiqus-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 12:14:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yunojuno",
"github_project": "django-amiqus",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "django-amiqus"
}
JSON
