Merge c5f4643 into 992a909

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,19 @@
+### Description
+
+TASK: [ASANA LINK](https://app.asana.com/X/XXXXXX/XXXXXX)
+
+Add a description of your changes here.
+
+### Notes
+- Example: Use example.sandbox.edraak.org to test against
+- Example: This PR will not address x,y, and z, because of a, b, and c.
+- Example: Feature is behind a flag
+- Example: Why I didn't add any tests
+
+### Testing
+- [ ] i18n
+- [ ] RTL
+- [ ] safecommit shows 0 violations
+- [ ] Unit, integration, acceptance tests as appropriate
+- [ ] Performance
+- [ ] Database migrations are backwards-compatible

.tx/config

@@ -0,0 +1,15 @@
+
+[main]
+host = https://www.transifex.com
+
+[edraak.proctoring]
+file_filter = conf/locale/<lang>/LC_MESSAGES/django.po
+source_file = conf/locale/en/LC_MESSAGES/django.po
+source_lang = en
+type = PO
+
+[edraak.proctoring-js]
+file_filter = conf/locale/<lang>/LC_MESSAGES/djangojs.po
+source_file = conf/locale/en/LC_MESSAGES/djangojs.po
+source_lang = en
+type = PO

Makefile

@@ -0,0 +1,42 @@
+all: install test
+
+.PHONY: install test
+
+# not used by travis
+install-system:
+	echo installing apt...
+
+# not used by travis
+install-node:
+	echo nodejs...
+
+install-sys-requirements: install-system install-node
+	npm config set loglevel warn
+
+install-wheels:
+	./scripts/install-wheels.sh
+
+install-js:
+	npm install
+
+install: install-wheels install-js
+
+install-test:
+	pip install -q -r test_requirements.txt
+
+install-python:
+	pip install -q -r local_requirements.txt --exists-action w
+
+install-coveralls:
+	pip install coveralls
+
+install-dev: install-python install-test install-coveralls
+
+test:
+	./scripts/run-tests.sh
+
+i18n-push:
+	./scripts/i18n-push.sh
+
+i18n-pull:
+	./scripts/i18n-pull.sh

README.md

@@ -1,29 +1,25 @@
-edx-proctoring [![Build Status](https://travis-ci.org/edx/edx-proctoring.svg?branch=master)](https://travis-ci.org/edx/edx-proctoring) [![Coverage Status](https://coveralls.io/repos/edx/edx-proctoring/badge.svg?branch=master&service=github)](https://coveralls.io/github/edx/edx-proctoring?branch=master)
+#Special Exams
 
-========================
+## edx-proctoring [![Build Status](https://travis-ci.org/edx/edx-proctoring.svg?branch=master)](https://travis-ci.org/edx/edx-proctoring) [![Coverage Status](https://coveralls.io/repos/edx/edx-proctoring/badge.svg?branch=master&service=github)](https://coveralls.io/github/edx/edx-proctoring?branch=master)
 
-This is the Exam Proctoring subsystem for the Open edX platform.
-
-
-While technical and developer documentation is forthcoming, here are basic instructions on how to use this
-in an Open edX installation.
+[User docs - Proctored Exams](http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_features/credit_courses/proctored_exams.html)
 
-NOTE: Proctoring will not be available in the Open edX named releases until Dogwood. However, you can use this if you use a copy of edx-platform (master) after 8/20/2015.
+[User docs - Timed Exams](http://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_features/timed_exams.html)
 
-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.
+## Description:
 
+This is the Exam Proctoring subsystem for the Open edX platform.
 
-CONFIGURATION:
+## Configuration:
 
 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,
-    :
-}
+    "FEATURES": {
+        :
+        "ENABLE_SPECIAL_EXAMS": true,
+        :
+    }
 ```
 
 Also in your lms.env.json and cms.env.json file please add the following:
@@ -57,3 +53,70 @@ In your lms.auth.json file, please add the following *secure* information:
 ```
 
 You will need to restart services after these configuration changes for them to take effect.
+
+
+## Installation
+
+The intent of this project is to be installed as Django apps that will be included in `edx-platform <https://github.com/edx/edx-platform>`_.
+
+Clone the repo:
+
+```
+    mkdir proctoring
+    cd proctoring
+    git clone git@github.com:Edraak/edx-proctoring.git
+```
+
+Create the Virtual Environment:
+
+```
+    mkvirtualenv development
+    workon development
+```
+
+To install all dependencies:
+
+```
+    make install-sys-requirements
+    make install
+    make install-dev
+```
+
+## Running Tests
+
+To run all python unit tests:
+
+```
+    make test
+```
+
+To run just the JavaScript tests:
+
+```
+    gulp test
+```
+
+## i18n
+
+You will need to:
+
+1. Install [i18n-tools](https://github.com/edx/i18n-tools)
+
+    ```
+        pip install git+git://github.com/edx/i18n-tools
+    ```
+
+2. Configure Transifex, as described in the [docs](http://docs.transifex.com/developer/client/setup)
+3. Install [gettext](http://www.gnu.org/software/gettext/)
+
+To extract strings and push to Transifex
+
+```
+    make i18n-push
+```
+
+To pull strings from Transifex
+
+```
+    make i18n-pull
+```

apt-packages.txt

@@ -0,0 +1,21 @@
+aspell
+g++
+gcc
+git
+gfortran
+libblas3gf
+libblas-dev
+liblapack3gf
+liblapack-dev
+libatlas-base-dev
+libfontconfig1
+libmysqlclient-dev
+libxml2-dev
+libxslt1-dev
+nodejs
+python2.7
+python2.7-dev
+python-mysqldb
+python-pip
+python-software-properties
+rubygems

conf/locale

@@ -0,0 +1 @@
+/home/salah/edx-proctoring/edx_proctoring/locale

edx_proctoring/locale/config.yaml

@@ -0,0 +1,21 @@
+# Configuration for i18n workflow.
+
+locales:
+    - en  # English - Source Language
+    - ar  # Arabic
+    # The other locales aren't useful for Edraak, so I've deleted them.
+
+# The locales used for fake-accented English, for testing.
+dummy_locales:
+    - eo
+
+# Directories we don't search for strings.
+ignore_dirs:
+    - docs
+    - logs
+    - node_modules
+    - performance
+    - requirements
+    - scripts
+    - settings
+    - storage