{ "info": { "author": "Matthew Egan", "author_email": "matthewj.egan@hotmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Framework :: Django :: 1.10", "Framework :: Django :: 1.11", "Framework :: Django :: 1.8", "Framework :: Django :: 1.9", "Framework :: Django :: 2.0", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet :: WWW/HTTP" ], "description": "\nDjango Gamification\n===================\n\n|PyPI version| |Build Status| |Downloads|\n\nDjango Gamification aims to fill the gamification sized hole in the\nDjango package ecosystem. In the current state, Django Gamification\nprovides a set of models that can be used to implement gamification\nfeatures in your application. These include a centralised interface for\nkeeping track of all gamification related objects including badges,\npoints, and unlockables.\n\nExample App\n-----------\nAn example app can be found `here `__.\n\nInstallation\n------------\n\nDownload from PyPI:\n\n::\n\n pip install django-gamification\n\nAnd add to your ``INSTALLED_APPS``:\n\n.. code:: python\n\n INSTALLED_APPS = [\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n .\n .\n .\n 'django_gamification'\n ]\n\nFeatures and Examples\n---------------------\n\nConcepts\n~~~~~~~~\n\nDjango Gamification requires the understanding of a few core concepts.\n\n- **BadgeDefinitions:** A template used to create new Badges and update existing Badges.\n- **Badge:** An object that represents some achievable objective in the system that can award points and track its own progression.\n- **UnlockableDefinition:** A template used to create new Unlockables and update existing Unlockables.\n- **Unlockable:** An object that is achieved by some accumulation of points.\n- **Category:** An object used to label other objects like Badges via their BadgeDefinition.\n\nInterfaces\n~~~~~~~~~~\n\nCreating an interface\n^^^^^^^^^^^^^^^^^^^^^\n\n.. code:: python\n\n\n from django.contrib.auth.models import User\n from django.db import models\n from django_gamification.models import GamificationInterface\n\n class YourUserModel(User):\n # Your user fields here\n\n # The gamification interface\n interface = models.ForeignKey(GamificationInterface)\n\nBadgeDefinitions and Badges\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCreating a new badge\n~~~~~~~~~~~~~~~~~~~~\n\nBy creating a new ``BadgeDefinition``, Django Gamification will\nautomatically create ``Badge`` instances for all your current\n``GamificationInterfaces`` with ``Badge.name``, ``Badge.description``,\n``Badge.points``, ``Badge.progression`` and ``Badge.category`` mimicking\nthe fields on the ``BadgeDefinition``.\n\n.. code:: python\n\n from django_gamification.models import BadgeDefinition, Category\n\n BadgeDefinition.objects.create(\n name='Badge of Awesome',\n description='You proved your awesomeness',\n points=50,\n progression_target=100,\n category=Category.objects.create(name='Gold Badges', description='These are the top badges'),\n )\n\nAwarding a badge\n~~~~~~~~~~~~~~~~\n\nYou can manually award a ``Badge`` instance using ``Badge.award()``.\n\n.. code:: python\n\n from django_gamification.models import Badge\n\n badge = Badge.objects.first()\n # badge.acquired = False\n\n badge.award()\n # badge.acquired = True\n\nUnlockableDefinitions and Unlockables\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nCreating a new unlockable\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nBy creating a new ``UnlockableDefinition``, Django Gamification will\nautomatically create ``Unlockable`` instances for all your current\n``GamificationInterfaces`` with ``Unlockable.name``,\n``Unlockable.description``, ``Unlockable.points_required`` mimicking the\nfields on the ``UnlockableDefinition``.\n\n.. code:: python\n\n from django_gamification.models import UnlockableDefinition\n\n UnlockableDefinition.objects.create(\n name='Some super sought after feature',\n description='You unlocked a super sought after feature',\n points_required=100\n )\n\nContributing\n------------\n\nSubmitting an issue or feature request\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you find an issue or have a feature request please open an issue at\n`Github Django Gamification\nRepo `__.\n\nWorking on issues\n~~~~~~~~~~~~~~~~~\n\nIf you think that you can fix an issue or implement a feature, please\nmake sure that it isn't assigned to someone or if it is you may ask for\nan update.\n\nOnce an issue is complete, open a pull request so that your contribution\ncan be reviewed. A TravisCI build will run and be attached to your pull\nrequest. Your code must pass these checks.\n\nGet Started!\n~~~~~~~~~~~~\n\nReady to contribute? Here's how to set up `django-gamification` for local\ndevelopment.\n\n1. Fork the `django-gamification` repo on GitHub.\n2. Clone your fork locally::\n\n $ git clone git@github.com:your_name_here/django-gamification.git\n\n3. Install your local copy into a virtualenv. Assuming you have\n virtualenvwrapper installed, this is how you set up your fork for local development::\n\n $ mkvirtualenv django-gamification\n $ cd django-gamification/\n $ python setup.py develop\n\n4. Create a branch for local development::\n\n $ git checkout -b name-of-your-bugfix-or-feature\n\n Now you can make your changes locally.\n\n5. When you're done making changes, check that your changes pass flake8 and the\n tests, including testing other Python versions with tox::\n\n $ py.test\n $ tox\n\n To get flake8 and tox, just pip install them into your virtualenv.\n\n6. Commit your changes and push your branch to GitHub::\n\n $ git add .\n $ git commit -m \"Your detailed description of your changes.\"\n $ git push origin name-of-your-bugfix-or-feature\n\n7. Submit a pull request through the GitHub website.\n\n\nHelping others\n~~~~~~~~~~~~~~\n\nAt all times, please be polite with others who are working on issues. It\nmay be their first ever patch and we want to foster a friendly and\nfamiliar open source environment.\n\n.. |PyPI version| image:: https://badge.fury.io/py/django-gamification.svg\n :target: https://badge.fury.io/py/django-gamification\n.. |Build Status| image:: https://travis-ci.org/mattjegan/django-gamification.svg?branch=master\n :target: https://travis-ci.org/mattjegan/django-gamification\n.. |Downloads| image:: http://pepy.tech/badge/django-gamification\n :target: http://pepy.tech/count/django-gamification\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/mattjegan/django-gamification", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "django-gamification", "package_url": "https://pypi.org/project/django-gamification/", "platform": "", "project_url": "https://pypi.org/project/django-gamification/", "project_urls": { "Homepage": "https://github.com/mattjegan/django-gamification" }, "release_url": "https://pypi.org/project/django-gamification/0.3.2/", "requires_dist": null, "requires_python": "", "summary": "The missing gamification plugin for Django", "version": "0.3.2" }, "last_serial": 4766979, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "4012b594240a1678335c84d0811b9d4d", "sha256": "e140e89662aa039d4365d6a847118c439fbc30ed52a71af31dbedfd579978cf5" }, "downloads": -1, "filename": "django_gamification-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4012b594240a1678335c84d0811b9d4d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5056, "upload_time": "2017-09-07T11:22:24", "url": "https://files.pythonhosted.org/packages/8a/ce/5bb3cd2702986cd99971e88f1c4bc446939ea0d60e965c65cc0eac32fa84/django_gamification-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5cdde24a4e8abb0dcdf18af622dea164", "sha256": "88becc620d8105d276128cd2dd05b8cb095e775fe90cd841538247d84e9e8f48" }, "downloads": -1, "filename": "django_gamification-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5cdde24a4e8abb0dcdf18af622dea164", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4440, "upload_time": "2017-09-07T11:22:27", "url": "https://files.pythonhosted.org/packages/e8/5e/6aba73a5e05b321f1ed4fd128382a808f60de5e918e0073af7ae2bb78ce6/django_gamification-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "97dbf91953e4c5b371612bf3f0273b61", "sha256": "d7183131f5f15eb302252a6f8e9d2e3032254d7d34cb616acf067d07186a34d1" }, "downloads": -1, "filename": "django_gamification-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "97dbf91953e4c5b371612bf3f0273b61", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5287, "upload_time": "2017-09-08T10:12:39", "url": "https://files.pythonhosted.org/packages/e3/db/bddc067a12cdf27c87fdc089db86a95ebf9d711fb62f4d5786e7f6036d72/django_gamification-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e4598c749ed352551feb56d270f3d48", "sha256": "4a089a5392d912839dbb4ca76d5a0628e764e22ce2953f2f906fafc0d156e9e9" }, "downloads": -1, "filename": "django_gamification-0.1.1.tar.gz", "has_sig": false, "md5_digest": "3e4598c749ed352551feb56d270f3d48", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4567, "upload_time": "2017-09-08T10:12:40", "url": "https://files.pythonhosted.org/packages/62/6c/f06f2557a2ff454fb6c72811ecc2a08049da392c904644c3240fd846c9ea/django_gamification-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "80580b39fd6f9fa84e24ba8b5a3bf59e", "sha256": "711cd59bee70480d0e3824992393a7c39ca7f30add3d9c9c39073f08c911987c" }, "downloads": -1, "filename": "django_gamification-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "80580b39fd6f9fa84e24ba8b5a3bf59e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6827, "upload_time": "2017-09-08T11:09:03", "url": "https://files.pythonhosted.org/packages/2c/25/4d84443a2eb856f4fe9a67cd8e3f6ee5746d31e2e0848679cb118dbb9df4/django_gamification-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "58fcdb2e8206c5b424c1a1f23f03266d", "sha256": "50dc814afa1404d3405b2f1369081b36f3797c73f2069238aaed501b6f65a0cb" }, "downloads": -1, "filename": "django_gamification-0.2.0.tar.gz", "has_sig": false, "md5_digest": "58fcdb2e8206c5b424c1a1f23f03266d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5477, "upload_time": "2017-09-08T11:09:04", "url": "https://files.pythonhosted.org/packages/f2/b4/aeffc6a7a3e1779a69ea60b5b8d8f7e7ed1c2b49012c1bbeccc983c442f3/django_gamification-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "5e565933b06b07f2397da836f4a1a8b5", "sha256": "76b711ec6fc07b74e16b8185c9bca94954459d572cbdb6ad0e5e4fd36d026536" }, "downloads": -1, "filename": "django_gamification-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5e565933b06b07f2397da836f4a1a8b5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7997, "upload_time": "2017-09-09T11:01:51", "url": "https://files.pythonhosted.org/packages/09/9f/56d4cb4c3dcfc9f00530fe256667eb4598af10df3be2a5f71d34df80c9cc/django_gamification-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2526568f265f5b65bd01cc2e96e5ce66", "sha256": "6e71f46ed9f97218ea4065042b2a587d2ef05a6ed71900c40ee3553325dc8e47" }, "downloads": -1, "filename": "django_gamification-0.2.1.tar.gz", "has_sig": false, "md5_digest": "2526568f265f5b65bd01cc2e96e5ce66", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6361, "upload_time": "2017-09-09T11:01:52", "url": "https://files.pythonhosted.org/packages/e7/79/32ebd3f5bd6636b1602b3fd4b812fe41cf113226aa189d6f3045f56cefcf/django_gamification-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "ee8643a628902f9ad6a4253c1bec71f8", "sha256": "fe9c53e62235e3a9f6967f7ce0526ba09ce40172027e29c34aebb3b4ac09aa9b" }, "downloads": -1, "filename": "django_gamification-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ee8643a628902f9ad6a4253c1bec71f8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9615, "upload_time": "2018-03-24T06:08:12", "url": "https://files.pythonhosted.org/packages/ce/e1/c545fe4f89f85716c0120550d693a8de1a363861ce8b0ad1b0759af2949b/django_gamification-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d69128ec4be80edd366d9f8d094f52a2", "sha256": "a8679959d881cf7acf7f9b98d903f5e4c8b685f49c0cd1e88a9fadf152f2f30f" }, "downloads": -1, "filename": "django_gamification-0.3.0.tar.gz", "has_sig": false, "md5_digest": "d69128ec4be80edd366d9f8d094f52a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7616, "upload_time": "2018-03-24T06:08:13", "url": "https://files.pythonhosted.org/packages/c1/05/dc3aef998e2dd5108d599c206f61a883636938726ccae12db0c3456b9478/django_gamification-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "5352e1b2c4fe191702dfefe1b1b5c20a", "sha256": "a5ac64e1344449d12992b882cad3204886fcfb549ab6445cc0162fadb3465bc8" }, "downloads": -1, "filename": "django_gamification-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5352e1b2c4fe191702dfefe1b1b5c20a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 17341, "upload_time": "2018-03-24T06:56:21", "url": "https://files.pythonhosted.org/packages/c6/78/3b120b220f570b48579c36fb434ed573dd2ad861bd6828cd1cb5ff17547f/django_gamification-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "959167abde8cc996c6006cd1e96c156e", "sha256": "f832bf3fda1bb9c2278906e6f312058772d2e89c2d4945039837915bf9668504" }, "downloads": -1, "filename": "django_gamification-0.3.1.tar.gz", "has_sig": false, "md5_digest": "959167abde8cc996c6006cd1e96c156e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10627, "upload_time": "2018-03-24T06:56:22", "url": "https://files.pythonhosted.org/packages/99/bc/678026890d588d310786c9b528af2547fa20c5a47f39c77210c4bd56d828/django_gamification-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "0411082925e207767aec83d047397258", "sha256": "823a4f4535148b3fa64afa0440032fddb6af372d3fbb5ad1321e90568ed1e708" }, "downloads": -1, "filename": "django_gamification-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0411082925e207767aec83d047397258", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 17467, "upload_time": "2019-02-01T05:32:45", "url": "https://files.pythonhosted.org/packages/ae/87/bb256c7ba26057ac83c6892c9422aaacb0b0e3884ad3e97636a9d4f41b23/django_gamification-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1db584da8466b31a9547b29b913a272a", "sha256": "fdbdce212032db75fc47b0f45124a6b94e74832b8a261fa6ae109440fd32f4d1" }, "downloads": -1, "filename": "django_gamification-0.3.2.tar.gz", "has_sig": false, "md5_digest": "1db584da8466b31a9547b29b913a272a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10723, "upload_time": "2019-02-01T05:32:47", "url": "https://files.pythonhosted.org/packages/8f/be/478be5e715eb1488eddc0bb4d28fd7381554f9f2e88880cd65b0bfe65582/django_gamification-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0411082925e207767aec83d047397258", "sha256": "823a4f4535148b3fa64afa0440032fddb6af372d3fbb5ad1321e90568ed1e708" }, "downloads": -1, "filename": "django_gamification-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0411082925e207767aec83d047397258", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 17467, "upload_time": "2019-02-01T05:32:45", "url": "https://files.pythonhosted.org/packages/ae/87/bb256c7ba26057ac83c6892c9422aaacb0b0e3884ad3e97636a9d4f41b23/django_gamification-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1db584da8466b31a9547b29b913a272a", "sha256": "fdbdce212032db75fc47b0f45124a6b94e74832b8a261fa6ae109440fd32f4d1" }, "downloads": -1, "filename": "django_gamification-0.3.2.tar.gz", "has_sig": false, "md5_digest": "1db584da8466b31a9547b29b913a272a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10723, "upload_time": "2019-02-01T05:32:47", "url": "https://files.pythonhosted.org/packages/8f/be/478be5e715eb1488eddc0bb4d28fd7381554f9f2e88880cd65b0bfe65582/django_gamification-0.3.2.tar.gz" } ] }