https://github.com/openedx/edx-proctoring

https://github.com/openedx/edx-proctoring

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/openedx/edx-proctoring
• Owner: openedx
• License: agpl-3.0
• Created: 2015-06-08T13:38:04.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-09T15:21:37.000Z (9 months ago)
• Last Synced: 2024-04-09T23:10:48.597Z (9 months ago)
• Language: Python
• Size: 11.4 MB
• Stars: 54
• Watchers: 119
• Forks: 82
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
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:

    mkvirtualenv edx-proctoring

    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 `_ for details.

Reporting Security Issues

-------------------------

Please do not report security issues in public. Please email [email protected].

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://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/proctored_exams/index.html