Metadata-Version: 1.1
Name: edx-proctoring
Version: 1.3.9
Summary: Proctoring subsystem for Open edX
Home-page: https://github.com/edx/edx-proctoring
Author: edX
Author-email: oscm@edx.org
License: AGPL 3.0
Description-Content-Type: UNKNOWN
Description: edx-proctoring
        =============================
        
        .. image:: https://img.shields.io/pypi/v/edx-proctoring.svg
            :target: https://pypi.python.org/pypi/edx-proctoring/
            :alt: PyPI
        
        .. image:: https://travis-ci.org/edx/edx-proctoring.svg?branch=master
            :target: https://travis-ci.org/edx/edx-proctoring
            :alt: Travis
        
        .. 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/edx/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 documentation about taking a proctored exam, see `Taking a Proctored Exam`_.
        
        For authoring documentation, see `Including Proctored Exams In Your Course`_.
        
        Installation
        ------------
        
        To install edx-proctoring:
        
            mkvirtualenv edx-proctoring
            make install
        
        To run the tests:
        
            make test-all
        
        For a full list of Make targets:
        
            make help
        
        Configuration
        -------------
        
        In order to use edx-proctoring, you must obtain an account (and secret
        configuration - see below) with SoftwareSecure, which provides the proctoring
        review services that edx-proctoring integrates with.
        
        You will need to turn on the ENABLE_SPECIAL_EXAMS in lms.env.json and
        cms.env.json FEATURES dictionary::
        
            "FEATURES": {
                :
                "ENABLE_SPECIAL_EXAMS": true,
                :
            }
        
        Also in your lms.env.json and cms.env.json file please add the following::
        
        
            "PROCTORING_SETTINGS": {
                "LINK_URLS": {
                    "contact_us": "{add link here}",
                    "faq": "{add link here}",
                    "online_proctoring_rules": "{add link here}",
                    "tech_requirements": "{add link here}"
                }
            },
        
        In your lms.auth.json file, please add the following *secure* information::
        
            "PROCTORING_BACKEND_PROVIDER": {
                "class": "edx_proctoring.backends.software_secure.SoftwareSecureBackendProvider",
                "options": {
                    "crypto_key": "{add SoftwareSecure crypto key here}",
                    "exam_register_endpoint": "{add enpoint to SoftwareSecure}",
                    "exam_sponsor": "{add SoftwareSecure sponsor}",
                    "organization": "{add SoftwareSecure organization}",
                    "secret_key": "{add SoftwareSecure secret key}",
                    "secret_key_id": "{add SoftwareSecure secret key id}",
                    "software_download_url": "{add SoftwareSecure download url}"
                }
            },
        
        You will need to restart services after these configuration changes for them to
        take effect.
        
        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/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
        
        Even though they were written with ``edx-platform`` in mind, the guidelines
        should be followed for Open edX code in general.
        
        Reporting Security Issues
        -------------------------
        
        Please do not report security issues in public. Please email security@edx.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: http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_features/credit_courses/proctored_exams.html
        
        
        We don't maintain a detailed changelog.  For details of changes, please see
        either the `GitHub commit history`_.
        
        .. _GitHub commit history: https://github.com/edx/edx-proctoring/commits/master
        
Keywords: Django edx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
