{
"info": {
"author": "Glen Jarvis",
"author_email": "glen@glenjarvis.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7"
],
"description": "==========\nbadgr-lite\n==========\n\nAutomate awarding Open Badges to recipients without the overhead of a server\n\n.. image:: https://img.shields.io/pypi/v/badgr_lite.svg\n :target: https://pypi.python.org/pypi/badgr_lite\n\n\n.. image:: https://img.shields.io/travis/glenjarvis/badgr-lite.svg\n :target: https://travis-ci.org/glenjarvis/badgr-lite\n\n\n.. image:: https://readthedocs.org/projects/badgr-lite/badge/?version=latest\n :target: https://badgr-lite.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\n.. image:: https://pyup.io/repos/github/glenjarvis/badgr-lite/shield.svg\n :target: https://pyup.io/repos/github/glenjarvis/badgr-lite/\n :alt: Updates\n\n\nPython support\n--------------\n\nThe badgr-lite library and command-line (CLI) should work in Python 3.5, 3.6\nand 3.7. You should be able to use this without error in those versions (and\npossibly other versions) as long as you do not need to regenerate the\ndocumentation. Generating the documentation shouldn't be needed as they are\nalready generated and online at `Read The Docs\n`_\n\nHowever, the documentation generation (i.e., Sphinx) support has removed Python\n3.5 support. These are considered developer only requirements.\n\nThe Sphinx library requires snowballstemmer >= 1.1. However, snowballstemmer\n2.0.0 was just released. That update to snowballtemmer fails with Python 3.5\ndue to a dependency with Python 3.6 or higher:\n\n``RuntimeError: yarl 1.4+ requires Python 3.6+``\n\nUntil this is resolved with the Sphinx project, official support for Python 3.5\nhas been removed from this project. However, please note that the only place\nthis dependency is needed is for Sphinx document generation. The badgr-lite\nlibrary itself has been tested with Python 3.5 and may work with other Python 3\nversions.\n\nQuick Start\n-----------\n\nManage your badges (with `Badgr`_ ), but automate the award and retrieval of\nbadges with `badger-lite `_.\n\n1. Create an account on either `Badgr`_ or an equivalent server.\n\n2. Use your `Badgr`_ (or equivalent) username and password\n to generate OAuth tokens for use with your project:\n\n .. code-block:: bash\n\n curl -X POST 'https://api.badgr.io/o/token' -d \"username=YOUREMAIL&password=YOURPASSWORD\" > token.json\n\n3. Install the `badgr-lite` package:\n\n .. code-block:: bash\n\n pip install badgr-lite\n\n Or (using the newly recommended way from Python.org:\n\n .. code-block:: bash\n\n pipenv install badgr-lite\n\n\nNow you can award badges through either the Command Line (CLI) or Library (SDK).\n\n\n.. _Badgr: https://badgr.io/\n\n\nCommand Line Example\n--------------------\n\nSample Command Help:\n\n .. code-block:: bash\n\n $ badgr --help\n Usage: badgr [OPTIONS] COMMAND [ARGS]...\n\n Automate Badgr tasks without the overhead of badgr-server\n\n Options:\n --token-file PATH File holding token credentials\n --help Show this message and exit.\n\n Commands:\n award-badge Award badge with BADGE_ID to RECIPIENT.\n list-badges Pull and print a list of badges from server\n\n\n``--token-file`` can be omitted if ``token.json`` filename is in current directory.\n\n .. code-block:: bash\n\n $ badgr --token-file token.json list-badges\n\n dTjxL52HQBiSgIp5JuVq5w https://badgr.io/public/assertions/dTjxL52HQBiSgIp5JuVq5w Bay Area Python Interest Group TDD Participant\n 6YhFytMUQb2loOMEy63gQA https://badgr.io/public/assertions/6YhFytMUQb2loOMEy63gQA Bay Area Python Interest Group TDD Quizmaster\n zzExTDvOTnOx_R3YhwPf3A https://badgr.io/public/assertions/zzExTDvOTnOx_R3YhwPf3A Test Driven Development Fundamentals Champion\n zNjcY70FSn603SO9vMGhBA https://badgr.io/public/assertions/zNjcY70FSn603SO9vMGhBA Install Python with Virtual Environments\n ZN0CIo4NR7-GgrliDJzoTw https://badgr.io/public/assertions/ZN0CIo4NR7-GgrliDJzoTw Fivvr badge\n\n\n .. code-block:: bash\n\n $ badgr --token-file token.json award-badge --badge-id 2TfNNqMLT8CoAhfGKqSv6Q --recipient recipient@example.com\n\n IfK18iLWSNWhvnQxLPHSxA https://badgr.io/public/assertions/IfK18iLWSNWhvnQxLPHSxA \n\n\nLibrary Examples\n----------------\n\nOne could patch together curl commands to interact with the Badgr server\n(although badgr-lite does make it much faster to get started). However, the\nreal benefit of Badgr-Lite is directly using its library in whatever tool that\nyou are using to automate award assignments (e.g., Django server, Flask server,\netc.).\n\n\n .. code-block:: python\n\n >>> from badgr_lite.models import BadgrLite\n >>> badge_id = '2TfNNqMLT8CoAhfGKqSv6Q'\n >>> badge_data = {\n ... \"recipient\": {\n ... \"identity\": \"recipient@example.com\",\n ... },\n ... }\n >>> badgr = BadgrLite(token_filename='./token.json')\n >>> badge = badgr.award_badge(badge_id, badge_data)\n >>> print(badge)\n q8nKaXMHTICZj7qhKEwutg https://badgr.io/public/assertions/q8nKaXMHTICZj7qhKEwutg \n\n\n .. warning::\n\n Do *not* check the ``token.json`` file into your code repository. This is a secret file and should\n be handled like any other file that stores passwords or secrets.\n\n\nPurpose\n-------\n\n`Open Badges `_ are images with credential data baked\ninto them. They are liked a digitally signed certificate that is also an image\nthat can be displayed on the web. They can be validated for authenticity and\nare a nice award to grant to people for jobs well done, passing quizzes and\nmuch more.\n\nMozilla recently partnered with `Concentric Sky\n`_. They built `Badgr`_ which makes badge\nmanagement so much easier (and less buggy).\n\nAt the time this project was created, however, there was no easy way to\nautomate the award of badges (e.g., on your own website) without having to\nbuild a full and complicated `badgr-server\n`_ of your own.\n\nThis `badgr-lite`_ project solves that problem.\n\n\nTutorial\n--------\nIf you are new to Open Badges and want to see how to use them (and automate\nthem with this project), go to `this tutorial\n`_.\n\n\n* Free software: MIT license\n* Documentation: https://badgr-lite.readthedocs.io.\n\n\n=======\nHistory\n=======\n\n0.0.1 (2019-09-26)\n------------------\n\n* First release on PyPI.\n\n1.0.0 (2019-10-03)\n------------------\n\n* Remove Travis support for Python 3.5 / `Pull request #27 `_\n* Update snowballstemmer to 2.0.0 / `Pull request #24 `_\n* [Fixes: #25] Remove support for Python 3.5 / `Pull request #26 `_\n* Update astroid to 2.3.1 / `Pull request #22 `_\n* [Fixes #20] Upgrade tox to 3.14.0 / `Pull request #21 `_\n* [Fixes #18] Fix README shields / `Pull request #19 `_\n\n\n\n",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/glenjarvis/badgr_lite",
"keywords": "OpenBadge",
"license": "MIT license",
"maintainer": "",
"maintainer_email": "",
"name": "badgr-lite",
"package_url": "https://pypi.org/project/badgr-lite/",
"platform": "",
"project_url": "https://pypi.org/project/badgr-lite/",
"project_urls": {
"Homepage": "https://github.com/glenjarvis/badgr_lite"
},
"release_url": "https://pypi.org/project/badgr-lite/1.0.0/",
"requires_dist": [
"Click",
"requests",
"pytz"
],
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"summary": "Automate awarding Badgr (or equivalent) badges to recipients without the overhead of badgr-server",
"version": "1.0.0"
},
"last_serial": 5925697,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "4edad4c3fd52c5ac34817945c454402f",
"sha256": "c3b5cc33c1b78fd77d32323992686007ee9fcf2ee43c734991616285661422d3"
},
"downloads": -1,
"filename": "badgr_lite-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4edad4c3fd52c5ac34817945c454402f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 9934,
"upload_time": "2019-09-26T21:05:31",
"url": "https://files.pythonhosted.org/packages/0b/d5/16a78c0420a4b3e91e20ad9329747a3134a4fde3737c2e00c4925d9b5735/badgr_lite-0.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "023814ea552e9d10e7fb2ebad25e9c1f",
"sha256": "1105990310a3dbe57f744d11dd5f8d45e13ec4b8d04a05ceb9fa688605761ba3"
},
"downloads": -1,
"filename": "badgr_lite-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "023814ea552e9d10e7fb2ebad25e9c1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 27623,
"upload_time": "2019-09-26T21:05:34",
"url": "https://files.pythonhosted.org/packages/f8/6e/72647cc79c00d9fe935d34b76e35f581afc65dd2eebf2b539e32209b70c4/badgr_lite-0.0.1.tar.gz"
}
],
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "87895626ddc0c03d6b5e262a33693e8a",
"sha256": "19b70c7463390615eae093f4dd66ea3585449a25475451d4571c62b816a73ef5"
},
"downloads": -1,
"filename": "badgr_lite-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "87895626ddc0c03d6b5e262a33693e8a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 10552,
"upload_time": "2019-10-03T22:35:35",
"url": "https://files.pythonhosted.org/packages/03/dd/89c611ecc76261289ef275f2bdacc66cc842deb9114062d9528ed2a6dfd3/badgr_lite-1.0.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2cf92e63062bfc46dbedfea580b0163b",
"sha256": "64863a3e6ac4b779637f567d0e764ab6948875eef1b25692c16a31e1d6e65d2c"
},
"downloads": -1,
"filename": "badgr_lite-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2cf92e63062bfc46dbedfea580b0163b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 29383,
"upload_time": "2019-10-03T22:35:37",
"url": "https://files.pythonhosted.org/packages/20/ff/df7059441d9ba0ef838404fd50b84da24446eed520a90e1df536d981c9fc/badgr_lite-1.0.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "87895626ddc0c03d6b5e262a33693e8a",
"sha256": "19b70c7463390615eae093f4dd66ea3585449a25475451d4571c62b816a73ef5"
},
"downloads": -1,
"filename": "badgr_lite-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "87895626ddc0c03d6b5e262a33693e8a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 10552,
"upload_time": "2019-10-03T22:35:35",
"url": "https://files.pythonhosted.org/packages/03/dd/89c611ecc76261289ef275f2bdacc66cc842deb9114062d9528ed2a6dfd3/badgr_lite-1.0.0-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "2cf92e63062bfc46dbedfea580b0163b",
"sha256": "64863a3e6ac4b779637f567d0e764ab6948875eef1b25692c16a31e1d6e65d2c"
},
"downloads": -1,
"filename": "badgr_lite-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2cf92e63062bfc46dbedfea580b0163b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 29383,
"upload_time": "2019-10-03T22:35:37",
"url": "https://files.pythonhosted.org/packages/20/ff/df7059441d9ba0ef838404fd50b84da24446eed520a90e1df536d981c9fc/badgr_lite-1.0.0.tar.gz"
}
]
}