<commit_before>==========
Django-FAQ
==========

This is a simple FAQ application for a Django powered site. This app follows
several "best practices" for reusable apps by allowing for template overrides
and extra_context arguments and such.

Features
========

Question Headers can be created that can be used to group related questions into
sections.

Questions can be "protected" in which case they are only presented to
authenticated users.

There are some saved FAQs in a fixture named ``initial_data.json`` that provide
the example apps with some questions to view when you bring them up for the
first time. These FAQs provide additional notes about installing and using
django-faq.

There is a ``SubmitFAQForm`` defined that you can use to allow site visitors to
submit new questions and/or answers to the site administrator for consideration.
All submitted questions are added as "inactive" and so it is up to the
administrator to edit, activate or discard the question as well as set its'
sort_order field and slug to reasonable values.

Installation
============

1. ``pip install django-faq``

2. Add ``"faq"`` to your ``INSTALLED_APPS`` setting.

3. Wire up the FAQ views by adding a line to your URLconf::<commit_msg>Added a note about requirements (Django 1.3, Python 2.5) to the README.<commit_after>==========
Django-FAQ
==========

This is a simple FAQ application for a Django powered site. This app follows
several "best practices" for reusable apps by allowing for template overrides
and extra_context arguments and such.

Features
========

Question Headers can be created that can be used to group related questions into
sections.

Questions can be "protected" in which case they are only presented to
authenticated users.

There are some saved FAQs in a fixture named ``initial_data.json`` that provide
the example apps with some questions to view when you bring them up for the
first time. These FAQs provide additional notes about installing and using
django-faq.

There is a ``SubmitFAQForm`` defined that you can use to allow site visitors to
submit new questions and/or answers to the site administrator for consideration.
All submitted questions are added as "inactive" and so it is up to the
administrator to edit, activate or discard the question as well as set its'
sort_order field and slug to reasonable values.

Requirements
============

Django 1.3, Python 2.5 or greater.

Installation
============

1. ``pip install django-faq``

2. Add ``"faq"`` to your ``INSTALLED_APPS`` setting.

3. Wire up the FAQ views by adding a line to your URLconf::
{'fraction_non_alphanumeric': 0.07981402557148393, 'fraction_numerical': 0.005424254165052305, 'mean_word_length': 4.662280701754386, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6733579', 'n_tokens_mistral': 685, 'n_tokens_neox': 645, 'n_words': 387}