persona-integration
#############################
.. note::
This README was auto-generated. Maintainer: please review its contents and
update all relevant sections. Instructions to you are marked with
"PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
note when you are done.
|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|
Purpose
*******
This repo contains the backend plugin that implements the Persona integration to be used for id verification.
TODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.
Describe your repo for the audience you intend it for.
Getting Started with Development
********************************
Add real content to describe how to deploy the component, and where the documentation is.
Deploying
*********
TODO: How can a new user go about deploying this component? Is it just a few
commands? Is there a larger how-to that should be linked here?
Add real content to describe how to deploy the component, and where the documentation is.
Getting Help
************
Documentation
=============
PLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.
.. _the documentation: https://docs.openedx.org/projects/persona-integration
(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
More Help
=========
Write a paragraph explaining how people can get help with the repo. Here are some possibilities:
“This repo is available for you to use, but we are unable to provide help.”
“If you are interested in using this repo, contact <PERSON>@2u.com, and we will see what we can do.”
License
*******
The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.
Please see `LICENSE.txt <LICENSE.txt>`_ for details.
Contributing
************
This repo is not currently accepting contributions.
The Open edX Code of Conduct
****************************
All community members are expected to follow the `Open edX Code of Conduct`_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
Reporting Security Issues
*************************
Please do not report security issues in public. Please email security@edx.org.
.. |pypi-badge| image:: https://img.shields.io/pypi/v/persona-integration.svg
:target: https://pypi.python.org/pypi/persona-integration/
:alt: PyPI
.. |ci-badge| image:: https://github.com/edx/persona-integration/workflows/Python%20CI/badge.svg?branch=main
:target: https://github.com/edx/persona-integration/actions
:alt: CI
.. |codecov-badge| image:: https://codecov.io/github/edx/persona-integration/coverage.svg?branch=main
:target: https://codecov.io/github/edx/persona-integration?branch=main
:alt: Codecov
.. |doc-badge| image:: https://readthedocs.org/projects/persona-integration/badge/?version=latest
:target: https://docs.openedx.org/projects/persona-integration
:alt: Documentation
.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/persona-integration.svg
:target: https://pypi.python.org/pypi/persona-integration/
:alt: Supported Python versions
.. |license-badge| image:: https://img.shields.io/github/license/edx/persona-integration.svg
:target: https://github.com/edx/persona-integration/blob/main/LICENSE.txt
:alt: License
.. TODO: Choose one of the statuses below and remove the other status-badge lines.
.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red
Change Log
##########
..
All enhancements and patches to persona_integration will be documented
in this file. It adheres to the structure of https://keepachangelog.com/ ,
but in reStructuredText instead of Markdown (for ease of incorporation into
Sphinx documentation and the PyPI description).
This project adheres to Semantic Versioning (https://semver.org/).
.. There should always be an "Unreleased" section for changes pending release.
Unreleased
**********
3.2.0 2024-12-18
****************
* Removed the requirement on Python 3.12 or greater.
* Added Python 3.11 to the matrix for the Python CI tests step.
* Added Python 3.11 to the tox envlist.
3.1.0 2024-12-18
****************
* Updated the is_valid_status_transition API method to allow terminal status transitions.
3.0.0 2024-10-25
*****************
Added
=====
* Upgraded to ``Python 3.12``
* Dropped support for ``Python<3.12``
2.2.0 2024-10-10
*****************
Added
=====
* Fix bug regarding mapping of status between this backend's VerificationAttempt model and the one in the LMS (The definitions of the "pending" status were different between the two models).
2.1.0 2024-10-09
*****************
Added
=====
* Fix bug preventing VerificationAttempt model from being synchronized to the LMS.
* Add VerificationAttempt.platform_verification_attempt_id field to admin.
2.0.4 - 2024-10-07
******************
Added
=====
* Fix errors in UserPersonaAccount and VerificationAttempt Django admin forms.
2.0.3 - 2024-09-27
******************
Added
=====
* Removed undesired email-related variables in Persona payload.
2.0.2 - 2024-09-27
******************
Added
=====
* Add __init__.py to signals package.
2.0.1 - 2024-09-26
******************
Added
=====
* Add user persona account model and admin.
* Add VerificationAttempt model and admin to store Persona attempts.
* Add a view to handle Persona webhooks.
* Add a create inquiry view.
* Add field for edx-platform VerificationAttempt model id.
* Add event listener for user retirement signal.
* Update name of reverse accessor on User model to resolve conflict.
* Modify VerificationAttemptView to return inquiry_id.
* Make several fixes to the VerificationAttemptView view and the create_inquiry API method.
* Replace field `verified_name` with `name_first` when communicating with persona.
* Fix an error on the payload for create_inquiry API call to Persona.
* Sync updates to VerificationAttempt model.
2.0.0 - 2024-09-25
******************
Added
=====
* Bump version.
1.0.0 - 2024-07-18
******************
Added
=====
* Initial release.
* Setup repo using template.
0.1.0 - 2024-07-18
******************
Added
=====
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/edx/persona-integration",
"name": "persona-integration",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "Python edx",
"author": "2U, Inc.",
"author_email": "team-cosmonauts@edx.org",
"download_url": "https://files.pythonhosted.org/packages/6a/ae/1096a5a9d171be8091515f7995a701d52d3464b35f553afcdc5a7b9c044d/persona_integration-3.2.0.tar.gz",
"platform": null,
"description": "persona-integration\n#############################\n\n.. note::\n\n This README was auto-generated. Maintainer: please review its contents and\n update all relevant sections. Instructions to you are marked with\n \"PLACEHOLDER\" or \"TODO\". Update or remove those sections, and remove this\n note when you are done.\n\n|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge| |status-badge|\n\nPurpose\n*******\n\nThis repo contains the backend plugin that implements the Persona integration to be used for id verification.\n\nTODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.\nDescribe your repo for the audience you intend it for.\n\nGetting Started with Development\n********************************\n\nAdd real content to describe how to deploy the component, and where the documentation is.\nDeploying\n*********\n\nTODO: How can a new user go about deploying this component? Is it just a few\ncommands? Is there a larger how-to that should be linked here?\n\nAdd real content to describe how to deploy the component, and where the documentation is.\nGetting Help\n************\n\nDocumentation\n=============\n\nPLACEHOLDER: Start by going through `the documentation`_. If you need more help see below.\n\n.. _the documentation: https://docs.openedx.org/projects/persona-integration\n\n(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)\n\nMore Help\n=========\n\nWrite a paragraph explaining how people can get help with the repo. Here are some possibilities:\n\n\u201cThis repo is available for you to use, but we are unable to provide help.\u201d\n\n\u201cIf you are interested in using this repo, contact <PERSON>@2u.com, and we will see what we can do.\u201d\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see `LICENSE.txt <LICENSE.txt>`_ for details.\n\nContributing\n************\n\nThis repo is not currently accepting contributions.\n\nThe Open edX Code of Conduct\n****************************\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@edx.org.\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/persona-integration.svg\n :target: https://pypi.python.org/pypi/persona-integration/\n :alt: PyPI\n\n.. |ci-badge| image:: https://github.com/edx/persona-integration/workflows/Python%20CI/badge.svg?branch=main\n :target: https://github.com/edx/persona-integration/actions\n :alt: CI\n\n.. |codecov-badge| image:: https://codecov.io/github/edx/persona-integration/coverage.svg?branch=main\n :target: https://codecov.io/github/edx/persona-integration?branch=main\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/persona-integration/badge/?version=latest\n :target: https://docs.openedx.org/projects/persona-integration\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/persona-integration.svg\n :target: https://pypi.python.org/pypi/persona-integration/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/persona-integration.svg\n :target: https://github.com/edx/persona-integration/blob/main/LICENSE.txt\n :alt: License\n\n.. TODO: Choose one of the statuses below and remove the other status-badge lines.\n.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange\n.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red\n\n\nChange Log\n##########\n\n..\n All enhancements and patches to persona_integration will be documented\n in this file. It adheres to the structure of https://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n\n This project adheres to Semantic Versioning (https://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n**********\n\n3.2.0 2024-12-18\n****************\n* Removed the requirement on Python 3.12 or greater. \n* Added Python 3.11 to the matrix for the Python CI tests step.\n* Added Python 3.11 to the tox envlist.\n\n3.1.0 2024-12-18\n****************\n* Updated the is_valid_status_transition API method to allow terminal status transitions.\n\n3.0.0 2024-10-25\n*****************\n\nAdded\n=====\n* Upgraded to ``Python 3.12``\n* Dropped support for ``Python<3.12``\n\n2.2.0 2024-10-10\n*****************\n\nAdded\n=====\n* Fix bug regarding mapping of status between this backend's VerificationAttempt model and the one in the LMS (The definitions of the \"pending\" status were different between the two models).\n\n2.1.0 2024-10-09\n*****************\n\nAdded\n=====\n* Fix bug preventing VerificationAttempt model from being synchronized to the LMS.\n* Add VerificationAttempt.platform_verification_attempt_id field to admin.\n\n2.0.4 - 2024-10-07\n******************\n\nAdded\n=====\n* Fix errors in UserPersonaAccount and VerificationAttempt Django admin forms.\n\n2.0.3 - 2024-09-27\n******************\n\nAdded\n=====\n* Removed undesired email-related variables in Persona payload.\n\n2.0.2 - 2024-09-27\n******************\n\nAdded\n=====\n* Add __init__.py to signals package.\n\n2.0.1 - 2024-09-26\n******************\n\nAdded\n=====\n* Add user persona account model and admin.\n* Add VerificationAttempt model and admin to store Persona attempts.\n* Add a view to handle Persona webhooks.\n* Add a create inquiry view.\n* Add field for edx-platform VerificationAttempt model id.\n* Add event listener for user retirement signal.\n* Update name of reverse accessor on User model to resolve conflict.\n* Modify VerificationAttemptView to return inquiry_id.\n* Make several fixes to the VerificationAttemptView view and the create_inquiry API method.\n* Replace field `verified_name` with `name_first` when communicating with persona.\n* Fix an error on the payload for create_inquiry API call to Persona.\n* Sync updates to VerificationAttempt model.\n\n2.0.0 - 2024-09-25\n******************\n\nAdded\n=====\n* Bump version.\n\n1.0.0 - 2024-07-18\n******************\n\nAdded\n=====\n\n* Initial release.\n* Setup repo using template.\n\n0.1.0 - 2024-07-18\n******************\n\nAdded\n=====\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "This repo contains the backend plugin that implements the Persona integration to be used for id",
"version": "3.2.0",
"project_urls": {
"Homepage": "https://github.com/edx/persona-integration"
},
"split_keywords": [
"python",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f79d39542e3d40700ceb024cb8f5868e0a81b9192029aa6428dbb9523c93a04",
"md5": "672732d0bd73b83a55780cf88f568674",
"sha256": "e4dc5dbdef6b278bd3bdadb328a9098fe697fbae3432e8f091a596f6500e7cf4"
},
"downloads": -1,
"filename": "persona_integration-3.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "672732d0bd73b83a55780cf88f568674",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.11",
"size": 48615,
"upload_time": "2024-12-18T23:10:51",
"upload_time_iso_8601": "2024-12-18T23:10:51.366111Z",
"url": "https://files.pythonhosted.org/packages/7f/79/d39542e3d40700ceb024cb8f5868e0a81b9192029aa6428dbb9523c93a04/persona_integration-3.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6aae1096a5a9d171be8091515f7995a701d52d3464b35f553afcdc5a7b9c044d",
"md5": "a2df1bc01d7c4df59c9476ae0d8243ab",
"sha256": "0993022d07f68ee1ddce8481261e0c75e8717670a305abf6fee9db3da34d9404"
},
"downloads": -1,
"filename": "persona_integration-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a2df1bc01d7c4df59c9476ae0d8243ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 45794,
"upload_time": "2024-12-18T23:10:53",
"upload_time_iso_8601": "2024-12-18T23:10:53.709332Z",
"url": "https://files.pythonhosted.org/packages/6a/ae/1096a5a9d171be8091515f7995a701d52d3464b35f553afcdc5a7b9c044d/persona_integration-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 23:10:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edx",
"github_project": "persona-integration",
"github_not_found": true,
"lcname": "persona-integration"
}
JSON
