{ "info": { "author": "Daniel Kaufhold", "author_email": "daniel.kaufhold@bitmazk.com", "bugtrack_url": null, "classifiers": [], "description": "Django Object FAQ\n=================\n\nA reusable Django app that allows to attach Q&As to any Django model instance.\n\nCurrently the app provides the models for adding translated questions and \nanswers as well as a template tag to render them from a default template, you\ncan of course override and customize according to your needs.\n\nFuture updates might include forms, that allow users to send their own\nquestions, but it is currently not implemented. Contributions are welcome =)\n\n\nInstallation\n------------\n\nTo get the latest stable release from PyPi\n\n.. code-block:: bash\n\n pip install django-object-faq\n\nTo get the latest commit from GitHub\n\n.. code-block:: bash\n\n pip install -e git+git://github.com/bitmazk/django-object-faq.git#egg=object_faq\n\n\nAdd ``object_faq`` to your ``INSTALLED_APPS``\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...,\n 'object_faq',\n )\n\nBefore your tags/filters are available in your templates, load them by using\n\n.. code-block:: html\n\n\t{% load object_faq_tags %}\n\nDon't forget to migrate your database\n\n.. code-block:: bash\n\n ./manage.py migrate object_faq\n\n\nUsage\n-----\n\nIn your django admin, you can create the ``Entry`` objects with questions and\nanswers to be rendered on the page. ``position`` is the default ordering of the\nqueryset.\n\nAdditionally you can setup a ``GlobalObjectDescription`` object per model\ninstance. This will render a general title and description, you might want to\nuse as introductory text for the object's FAQ or just as general object\ndescription.\n\nThen you only need to add the template tag for the object in the context.\n.. code-block:: html\n\n\t{% load object_faq_tags %}\n\n {% render_faq_for_object myobject %}\n\nThis will automatically render the tempalte located at\n``object_faq/partials/object_faq.html``.\n\n\nContribute\n----------\n\nIf you want to contribute to this project, please perform the following steps\n\n.. code-block:: bash\n\n # Fork this repository\n # Clone your fork\n mkvirtualenv -p python2.7 django-object-faq\n make develop\n\n git co -b feature_branch master\n # Implement your feature and tests\n git add . && git commit\n git push -u origin feature_branch\n # Send us a pull request for your feature branch", "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/bitmazk/django-object-faq", "keywords": "django,app,reusable,faq,frequently,generic,question,answer", "license": "The MIT License", "maintainer": null, "maintainer_email": null, "name": "django-object-faq", "package_url": "https://pypi.org/project/django-object-faq/", "platform": "OS Independent", "project_url": "https://pypi.org/project/django-object-faq/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/bitmazk/django-object-faq" }, "release_url": "https://pypi.org/project/django-object-faq/0.1/", "requires_dist": null, "requires_python": null, "summary": "A reusable Django app that allows to attach Q&As to any Django model instance", "version": "0.1" }, "last_serial": 939723, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "c24e8d41536bcaa6d023a097f98c63d2", "sha256": "922a9d874bf17bfe709b77fe3b3c06d4a91ae83004d76fda3ecfd561b1145679" }, "downloads": -1, "filename": "django-object-faq-0.1.tar.gz", "has_sig": false, "md5_digest": "c24e8d41536bcaa6d023a097f98c63d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9443, "upload_time": "2013-12-09T10:09:57", "url": "https://files.pythonhosted.org/packages/7a/f7/b73b72638e19c7b3754295f71e4d6df9461f2e59c62b2401c81835dbfdc5/django-object-faq-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c24e8d41536bcaa6d023a097f98c63d2", "sha256": "922a9d874bf17bfe709b77fe3b3c06d4a91ae83004d76fda3ecfd561b1145679" }, "downloads": -1, "filename": "django-object-faq-0.1.tar.gz", "has_sig": false, "md5_digest": "c24e8d41536bcaa6d023a097f98c63d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9443, "upload_time": "2013-12-09T10:09:57", "url": "https://files.pythonhosted.org/packages/7a/f7/b73b72638e19c7b3754295f71e4d6df9461f2e59c62b2401c81835dbfdc5/django-object-faq-0.1.tar.gz" } ] }