Metadata-Version: 2.4
Name: edx-proctoring
Version: 6.2.0
Summary: Proctoring subsystem for Open edX
Author-email: Open edX Project <oscm@openedx.org>
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://github.com/openedx/edx-proctoring
Project-URL: Repository, https://github.com/openedx/edx-proctoring
Keywords: Django,edx
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: Django>=2.2
Requires-Dist: django-model-utils
Requires-Dist: djangorestframework
Requires-Dist: django-ipware>=1.1.0
Requires-Dist: jsonfield
Requires-Dist: pyjwt[crypto]>=2.1.0
Requires-Dist: pytz>=2018
Requires-Dist: pycryptodomex>=3.4.7
Requires-Dist: django-crum
Requires-Dist: python-dateutil>=2.1
Requires-Dist: django-simple-history
Requires-Dist: django-webpack-loader>=0.6.0
Requires-Dist: django-waffle
Requires-Dist: rules
Requires-Dist: event-tracking>=0.2.5
Requires-Dist: edx-opaque-keys>=0.4
Requires-Dist: edx-drf-extensions
Requires-Dist: edx-rest-api-client>=1.9.2
Requires-Dist: edx-when>=0.1.3
Dynamic: license-file

edx-proctoring
==============

.. image:: https://img.shields.io/pypi/v/edx-proctoring.svg
    :target: https://pypi.python.org/pypi/edx-proctoring/
    :alt: PyPI

.. image:: https://github.com/openedx/edx-proctoring/workflows/Python%20CI/badge.svg
    :target: https://github.com/openedx/edx-proctoring/actions?query=workflow%3A%22Python+CI%22
    :alt: Python CI

.. image:: https://codecov.io/gh/edx/edx-proctoring/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/edx/edx-proctoring
    :alt: Codecov

.. image:: https://img.shields.io/pypi/pyversions/edx-proctoring.svg
    :target: https://pypi.python.org/pypi/edx-proctoring/
    :alt: Supported Python versions

.. image:: https://img.shields.io/github/license/edx/django-component-views.svg
    :target: https://github.com/openedx/edx-proctoring/blob/master/LICENSE.txt
    :alt: License

This is the exam proctoring subsystem for the Open edX platform.

Overview
--------

Proctored exams are exams with time limits that learners complete while online
proctoring software monitors their computers and behavior for activity that
might be evidence of cheating. This Python library provides the proctoring
implementation used by Open edX.

Documentation
-------------

For authoring documentation, see `Including Proctored Exams In Your Course`_.

Installation
------------

To install edx-proctoring (requires `uv <https://docs.astral.sh/uv/>`_), create and activate the
project virtualenv at ``.venv``, then install. ``uv sync`` ignores any other active virtualenv, so run
the ``make`` commands below with ``.venv`` activated:

    uv venv

    source .venv/bin/activate

    make install

If you want to run tests, first setup requirements. Note that JS tests
require Node 10, nvm install v10 if you are on a different version so
that gulp is installed for v10:

    nvm install v10

    make requirements-test

Run tests:

    make test

Run just python tests:

    make test-python

Run just JS tests:

    make test-js

For a full list of Make targets:

    make help

Developing
-------------

See the `developer guide`_ for configuration, devstack and sandbox setup, and other developer concerns.

.. _developer guide: ./docs/developing.rst

License
-------

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see ``LICENSE.txt`` for details.

How To Contribute
-----------------

Contributions are very welcome.

Please read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`_ for details.


Reporting Security Issues
-------------------------

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

Getting Help
------------

Have a question about this repository, or about Open edX in general?  Please
refer to this `list of resources`_ if you need any assistance.

.. _list of resources: https://open.edx.org/getting-help
.. _Including Proctored Exams In Your Course: https://docs.openedx.org/en/latest/educators/concepts/proctored_exams/proctored_exams_overview.html
