{ "info": { "author": "Acclaim", "author_email": "yancy.ribbens@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Intended Audience :: Developers", "License :: Other/Proprietary License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5" ], "description": "acclaim-badges\n=============================\n\n|pypi-badge| |travis-badge| |codecov-badge| |doc-badge| |pyversions-badge|\n|license-badge|\n\nIssue badges from Acclaim upon edx course completion.\n\nAcclaim Badges for EDX\n\nOverview\n------------------------\n\nAdds a djangoapp to edx which provides a UI and API backend into Acclaim. Once installed, EDX adminstrators\nwill be able to add Acclaim auth tokens and select badges to be issued upon course completion. This app\nthen listens for course complete events, and issues badges if the student obtains a passing score.\n\nInstall\n------------------------\n1. Install \"acclaim_badges\" using pip::\n\n pip install acclaim_badges\n\n2. Add \"acclaim_badges\" to your INSTALLED_APPS setting for EDX lms like this::\n \n INSTALLED_APPS = [\n ...\n 'acclaim_badges',\n ]\n\nNote: this file is usually located at ``/edx-platform/lms/envs/common.py``\n\n3. Include the acclaim_badges URLconf in your project urls.py like this::\n\n urlpatterns += (\n url(r'^acclaim/', include('acclaim_badges.urls')),\n )\n\n4. The authorization token field is encypted. create a AES-256 keyset using keyzar::\n\n $ mkdir fieldkeys\n $ keyczart create --location=fieldkeys --purpose=crypt\n $ keyczart addkey --location=fieldkeys --status=primary --size=256\n\n5. Add keyset location to ``/edx-platform/lms/envs/common.py``::\n\n ENCRYPTED_FIELDS_KEYDIR = '/path/to/fieldkeys'\n\n6. Run ``./manage.py lms syncdb --settings aws`` to create the acclaim_badges lms app.\n\nUsage\n-------------\nThe following useful URLs are made available after installation:\n``/acclaim/tokens/``\n``/acclaim/badge-courses/``\n\n1) Add Acclaim organization and authorization token using ``/acclaim/tokens/``\n2) Define a mapping between badge and course by accessing ``/acclaim/badge-courses/``\n\nNote: when defining a mapping, the dropdown will populate with badge templates\nif the Acclaim API call is successful (valid token and orgainzation combination are used).\n\nDocumentation\n-------------\n\nThe full documentation is at https://acclaim-badges.readthedocs.org.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless\notherwise noted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome.\n\nPlease read `How To Contribute `_ for details.\n\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for Open edX code in general.\n\nPR description template should be automatically applied if you are sending PR from github interface; otherwise you\ncan find it it at `PULL_REQUEST_TEMPLATE.md `_\n\nIssue report template should be automatically applied if you are sending it from github UI as well; otherwise you\ncan find it at `ISSUE_TEMPLATE.md `_\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/acclaim-badges.svg\n :target: https://pypi.python.org/pypi/acclaim-badges/\n :alt: PyPI\n\n.. |travis-badge| image:: https://travis-ci.org/edx/acclaim-badges.svg?branch=master\n :target: https://travis-ci.org/edx/acclaim-badges\n :alt: Travis\n\n.. |codecov-badge| image:: http://codecov.io/github/edx/acclaim-badges/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/acclaim-badges?branch=master\n :alt: Codecov\n\n.. |doc-badge| image:: https://readthedocs.org/projects/acclaim-badges/badge/?version=latest\n :target: http://acclaim-badges.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/acclaim-badges.svg\n :target: https://pypi.python.org/pypi/acclaim-badges/\n :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/acclaim-badges.svg\n :target: https://github.com/edx/acclaim-badges/blob/master/LICENSE.txt\n :alt: License\n\n\nChange Log\n----------\n\n..\n All enhancements and patches to acclaim_badges will be documented\n in this file. It adheres to the structure of http://keepachangelog.com/ ,\n but in reStructuredText instead of Markdown (for ease of incorporation into\n Sphinx documentation and the PyPI description).\n \n This project adheres to Semantic Versioning (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\nUnreleased\n~~~~~~~~~~\n\n*\n\n[0.1.0] - 2017-05-10\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdded\n_____\n\n* First release on PyPI.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/YourAcclaim/Acclaim-Badges-for-EDX", "keywords": "Django edx", "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "acclaim-badges", "package_url": "https://pypi.org/project/acclaim-badges/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/acclaim-badges/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/YourAcclaim/Acclaim-Badges-for-EDX" }, "release_url": "https://pypi.org/project/acclaim-badges/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Acclaim Badges for EDX", "version": "0.1.0" }, "last_serial": 2928192, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "154207cfe89ebf718f81b14e538c4991", "sha256": "7d7cc6fe25c47cc502e3a990c4a941ac8b5625fc9cc946eec2fbbfb62796e35d" }, "downloads": -1, "filename": "acclaim_badges-0.1.0-py2.7.egg", "has_sig": false, "md5_digest": "154207cfe89ebf718f81b14e538c4991", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 41623, "upload_time": "2017-06-06T04:01:23", "url": "https://files.pythonhosted.org/packages/cc/53/ece9435ef6824dc09eafffae58b0e41fdc839d686437e4dc19911413b635/acclaim_badges-0.1.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "4356ac7ddea8420322aa8bf3211f5dc8", "sha256": "e7f3bac163a8f56c5cafe1bc68747bc669cce4d4a17159246fdb3a7a3279ac98" }, "downloads": -1, "filename": "acclaim_badges-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4356ac7ddea8420322aa8bf3211f5dc8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 37232, "upload_time": "2017-06-06T04:01:25", "url": "https://files.pythonhosted.org/packages/c2/5e/f4df4115b16d9e5778b094953816a298d1e614d51e47705e7e816c48b28f/acclaim_badges-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d66aee1814868bc4ba36820c38063796", "sha256": "a36d07c428ec3122623dd736e135cb156eae3127cd950676cd3fd6c7196296ed" }, "downloads": -1, "filename": "acclaim-badges-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d66aee1814868bc4ba36820c38063796", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31763, "upload_time": "2017-06-06T04:01:28", "url": "https://files.pythonhosted.org/packages/7c/59/21546c836a5b8d0f64be24501425d5458f48e4852f3b1380d9b523c2bbf9/acclaim-badges-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "154207cfe89ebf718f81b14e538c4991", "sha256": "7d7cc6fe25c47cc502e3a990c4a941ac8b5625fc9cc946eec2fbbfb62796e35d" }, "downloads": -1, "filename": "acclaim_badges-0.1.0-py2.7.egg", "has_sig": false, "md5_digest": "154207cfe89ebf718f81b14e538c4991", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 41623, "upload_time": "2017-06-06T04:01:23", "url": "https://files.pythonhosted.org/packages/cc/53/ece9435ef6824dc09eafffae58b0e41fdc839d686437e4dc19911413b635/acclaim_badges-0.1.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "4356ac7ddea8420322aa8bf3211f5dc8", "sha256": "e7f3bac163a8f56c5cafe1bc68747bc669cce4d4a17159246fdb3a7a3279ac98" }, "downloads": -1, "filename": "acclaim_badges-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4356ac7ddea8420322aa8bf3211f5dc8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 37232, "upload_time": "2017-06-06T04:01:25", "url": "https://files.pythonhosted.org/packages/c2/5e/f4df4115b16d9e5778b094953816a298d1e614d51e47705e7e816c48b28f/acclaim_badges-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d66aee1814868bc4ba36820c38063796", "sha256": "a36d07c428ec3122623dd736e135cb156eae3127cd950676cd3fd6c7196296ed" }, "downloads": -1, "filename": "acclaim-badges-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d66aee1814868bc4ba36820c38063796", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31763, "upload_time": "2017-06-06T04:01:28", "url": "https://files.pythonhosted.org/packages/7c/59/21546c836a5b8d0f64be24501425d5458f48e4852f3b1380d9b523c2bbf9/acclaim-badges-0.1.0.tar.gz" } ] }