Skip to main content

This repo contains the backend plugin that implements the Persona integration to be used for id

Project description

persona-integration

PyPI CI Codecov Documentation Supported Python versions License 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.

(TODO: Set up documentation)

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 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.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Change Log

Unreleased

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

persona_integration-3.1.0.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

persona_integration-3.1.0-py2.py3-none-any.whl (48.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file persona_integration-3.1.0.tar.gz.

File metadata

  • Download URL: persona_integration-3.1.0.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for persona_integration-3.1.0.tar.gz
Algorithm Hash digest
SHA256 46036ff47734bc71bb237d0afc00d7858666d2eb416e998472e56d447714b8c3
MD5 9742f72f1c0cffe4c85f1c85153e0b79
BLAKE2b-256 cae18e14e67b8e0e3416e79e41934c6399b087fa2866aa5ce02e297f588dcf9f

See more details on using hashes here.

File details

Details for the file persona_integration-3.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for persona_integration-3.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a15f0b27511abd98dfffb5ea7db7595509a9441ded8e3a88afa29ca590268a8a
MD5 751ca2c43e1263537749583d27c3f60e
BLAKE2b-256 febef0d68ff4313fdaf886044effd237613984eb7d1e4a201b520d2939f0f610

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page