{ "info": { "author": "Brian Knobbs", "author_email": "brian@packetperception.org", "bugtrack_url": null, "classifiers": [], "description": "Pychievements: The Python Achievments Framework!\n================================================\n\n|build| |docs| |coverage| |downloads| |license|\n\n.. |coverage| image:: https://coveralls.io/repos/PacketPerception/pychievements/badge.png?branch=master\n :target: https://coveralls.io/r/PacketPerception/pychievements?branch=master\n\n.. |build| image:: https://travis-ci.org/PacketPerception/pychievements.svg?branch=master\n :target: https://travis-ci.org/PacketPerception/pychievements\n\n.. |docs| image:: https://readthedocs.org/projects/pychievements/badge/?version=latest\n :target: http://pychievements.readthedocs.org/en/latest/\n\n.. |downloads| image:: https://pypip.in/download/pychievements/badge.svg\n :target: https://pypi.python.org/pypi/pychievements/\n :alt: Downloads\n\n.. |license| image:: https://pypip.in/license/pychievements/badge.svg\n :target: https://pypi.python.org/pypi/pychievements/\n :alt: License\n\n**Pychievements** is a framework for creating and tracking achievements within a Python application.\nIt includes functions specifically for creating command line applications, though it is flexible \nenough to be used for any application such as web applications.\n\nSee the examples_ to get a good feel for what Pychievements offers. Documentation can be found RTD:\nhttp://pychievements.readthedocs.org/en/latest/\n\n.. _examples: https://github.com/PacketPerception/pychievements/tree/master/examples\n\n\nFeatures:\n---------\n - Create Achievements with any number of \"goals\" (based on levels) that can be reached\n - Flexible design makes it easy to customize the way levels are tracked\n - Easy to add new achievements later\n - Pluggable backend for storing tracked information in different formats to different locations\n - Achievements can be filtered by category or keywords\n - Easily specify \"Icons\" for individual goals within an achievement for dual states (achieved and\n unachieved)\n\n\nExample\n-------\n\nA simple achievement. ::\n\n class MyAchievement(Achievement):\n name = \"My Achievement\"\n category = \"achievements\"\n keywords = (\"my\", \"achievement\")\n goals = (\n {\"level\": 10, \"name\": \"Level 1\", \"icon\": icons.star, \"description\": \"Level One\"},\n {\"level\": 20, \"name\": \"Level 2\", \"icon\": icons.star, \"description\": \"Level Two\"},\n {\"level\": 30, \"name\": \"Level 3\", \"icon\": icons.star, \"description\": \"Level Three\"},\n )\n\n\nIncrement a level for a user. ::\n\n tracker.increment(user_id, MyAchievment)\n\n\nRe-evaluating a level for a user based on arguments (requires the evaluate function to be defined \nor the Achievement). ::\n\n tracker.evaluate(user_id, MyAchievement, some, extra, args)\n\n\nRetrieve achievements. ::\n\n tracker.achievements() # retrieves all registered achievements in the tracker\n tracker.achieved(uid, achievement) # all achieved goals by uid for achievement\n tracker.unachieved(uid, achievement) # all unachieved goals by uid for achievement\n tracker.current(uid, achievement) # goal currently being worked torwards by uid\n\n\nInstallation\n------------\n\nTo install pychievements, simply: ::\n\n $ pip install pychievements\n\n\nLicense\n-------\n\nPychievements is licensed under the MIT License, see the LICENSE_.\n\n.. _LICENSE: http://github.com/PacketPerception/pychievements/blob/master/LICENSE\n\n\nContribute\n----------\n\nIf you'd like to contribute, simply fork `the repository`_, commit your changes\nto the **master** branch (or branch off of it), and send a pull request. Make\nsure you add yourself to AUTHORS_.\n\n\n.. _`the repository`: http://github.com/PacketPerception/pychievements\n.. _AUTHORS: http://github.com/PacketPerception/pychievements/blob/master/AUTHORS\n\n\nRoadmap\n-------\n- More backends\n- More icons\n\n\nHistory\n-------\n\n0.1.0 (2014-08-31)\n++++++++++++++++++\n\n* Initial Release!", "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/PacketPerception/pychievements", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "pychievements", "package_url": "https://pypi.org/project/pychievements/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pychievements/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/PacketPerception/pychievements" }, "release_url": "https://pypi.org/project/pychievements/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "Python Achievements Framework", "version": "0.1.2" }, "last_serial": 1211041, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "57e5ba466a6bd20b63ebc37f78001da7", "sha256": "62eb7cf9dcfb7a4c29aecc12d41b965c52aa4c0406c6a175c2703ea58ede9460" }, "downloads": -1, "filename": "pychievements-0.1.2.tar.gz", "has_sig": false, "md5_digest": "57e5ba466a6bd20b63ebc37f78001da7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12976, "upload_time": "2014-09-03T02:18:46", "url": "https://files.pythonhosted.org/packages/9e/7b/7ac1d5aca86a112070f5abceb272ab2f58dc9556edffca6444bd6847483b/pychievements-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "57e5ba466a6bd20b63ebc37f78001da7", "sha256": "62eb7cf9dcfb7a4c29aecc12d41b965c52aa4c0406c6a175c2703ea58ede9460" }, "downloads": -1, "filename": "pychievements-0.1.2.tar.gz", "has_sig": false, "md5_digest": "57e5ba466a6bd20b63ebc37f78001da7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12976, "upload_time": "2014-09-03T02:18:46", "url": "https://files.pythonhosted.org/packages/9e/7b/7ac1d5aca86a112070f5abceb272ab2f58dc9556edffca6444bd6847483b/pychievements-0.1.2.tar.gz" } ] }