Ginkgo.2 support

examus · Jun 29, 2018 · ee600e1 · ee600e1
1 parent b72f072
commit ee600e1
Show file tree

Hide file tree

Showing 33 changed files with 86 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# open_edx_api_extension
+
+API extension for Open edX 
+
+Installation:
+```bash
+pip install -e git+https://github.com/raccoongang/open_edx_api_extension.git#egg=open_edx_api_extension
+```
+
+Add in file lms/envs/common.py
+```python
+INSTALLED_APPS = (
+    ...
+    'open_edx_api_extension',
+)
+```
+
+Add in file lms/urls.py
+
+```python
+urlpatterns = (
+    ...
+    url(r'^api/extended/', include('open_edx_api_extension.urls', namespace='api_extension')),
+)
+```
+
+## There are two API endpoints:
+
+### Course list
+
+/api/extended/courses/
+
+NOTE: For use it be sure you set EDX_API_KEY in Open edX LMS environment settings
+
+Example:
+
+```bash
+ curl -X GET http://<your.lms.domain>/api/extended/courses/?format=json -H 'X-Edx-Api-Key: edx-api-key'
+```
+
+### Course User Results
+
+/api/extended/courses/{course_id}/{username}/
+
+This endpoint uses standard oauth access.
+
+
+### Enrollments list
+
+/api/extended/enrollment
+
+Get a list of all courses enrollments.
+Used EDX_API_KEY for access to this API
+
+See original documentation for other attributes and usage:
+http://edx-platform-api.readthedocs.org/en/latest/enrollment/enrollment.html#enrollment.views.EnrollmentView
diff --git a/__init__.pyc b/__init__.pyc
diff --git a/api_client.pyc b/api_client.pyc
diff --git a/data.pyc b/data.pyc
diff --git a/edx_release.py.save b/edx_release.py.save
diff --git a/edx_release.pyc b/edx_release.pyc
diff --git a/ficus.pyc b/ficus.pyc
diff --git a/ginkgo.pyc b/ginkgo.pyc
diff --git a/mixins.pyc b/mixins.pyc
diff --git a/models.pyc b/models.pyc
diff --git a/__init__.py → open_edx_api_extension/__init__.py b/__init__.py → open_edx_api_extension/__init__.py
diff --git a/api_client.py → open_edx_api_extension/api_client.py b/api_client.py → open_edx_api_extension/api_client.py
diff --git a/data.py → open_edx_api_extension/data.py b/data.py → open_edx_api_extension/data.py
diff --git a/edx_release.py → open_edx_api_extension/edx_release.py b/edx_release.py → open_edx_api_extension/edx_release.py
diff --git a/ficus.py → open_edx_api_extension/ficus.py b/ficus.py → open_edx_api_extension/ficus.py
diff --git a/ginkgo.py → open_edx_api_extension/ginkgo.py b/ginkgo.py → open_edx_api_extension/ginkgo.py
diff --git a/mixins.py → open_edx_api_extension/mixins.py b/mixins.py → open_edx_api_extension/mixins.py
diff --git a/models.py → open_edx_api_extension/models.py b/models.py → open_edx_api_extension/models.py
diff --git a/serializers.py → open_edx_api_extension/serializers.py b/serializers.py → open_edx_api_extension/serializers.py
diff --git a/signals.py → open_edx_api_extension/signals.py b/signals.py → open_edx_api_extension/signals.py
diff --git a/tasks.py → open_edx_api_extension/tasks.py b/tasks.py → open_edx_api_extension/tasks.py
diff --git a/tracking.py → open_edx_api_extension/tracking.py b/tracking.py → open_edx_api_extension/tracking.py
diff --git a/urls.py → open_edx_api_extension/urls.py b/urls.py → open_edx_api_extension/urls.py
diff --git a/utils.py → open_edx_api_extension/utils.py b/utils.py → open_edx_api_extension/utils.py
diff --git a/views.py → open_edx_api_extension/views.py b/views.py → open_edx_api_extension/views.py
diff --git a/serializers.pyc b/serializers.pyc
diff --git a/setup.py b/setup.py
@@ -0,0 +1,30 @@
+import os
+from setuptools import setup
+
+with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
+    README = readme.read()
+
+# allow setup.py to be run from any path
+os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
+
+setup(
+    name='open-edx-api-extension',
+    version='0.1',
+    packages=['open_edx_api_extension'],
+    include_package_data=True,
+    description='API extension for Open edX',
+    long_description=README,
+    url='https://github.com/raccoongang/open_edx_api_extension',
+    author='Aleksey Radchenko',
+    author_email='[email protected]',
+    classifiers=[
+        'Environment :: Web Environment',
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+    ],
+)
diff --git a/signals.pyc b/signals.pyc
diff --git a/tasks.pyc b/tasks.pyc
diff --git a/tracking.pyc b/tracking.pyc
diff --git a/urls.pyc b/urls.pyc
diff --git a/utils.pyc b/utils.pyc
diff --git a/views.pyc b/views.pyc