Skip to main content

Simple knowledge base made with django

Project description

Django KB

.. image::
:alt: Latest Version

.. image::
:alt: Supported Python versions

.. image::
:alt: Download format

.. image::

.. image::

Simple knowledge base made with django


#. Install or add ``django-kb`` to your Python path, i.e.:

.. code:: sh

$ pip install django-kb

#. Add ``kb`` to your ``INSTALLED_APPS`` setting.

#. Add kb url include to your project's ```` file with namespaece ``kb``::

(r'^', include('kb.urls', namespace='kb')),

#. Add ``kb.middleware.KnowledgeMiddleware`` to your ``MIDDLEWARE_CLASSES`` setting, i.e.::



Template Tags

Loading the tags, i.e.::

{% load kbtags %}

{% top_new_articles %}

Return the new published articles.

{% top_viewed_articles %}

Return the most viewed articles.

{% top_rated_articles %}

Return the most rated articles.

All this tags accept two optional parameters, ``num`` and ``category``.
``num`` is the number of the articles that will return, by default to 5.
``category`` can be a ``model`` or ``slug`` that will be used to filter the articles.

{% feedback %}

This is an inclusion tag which renders links to upvote or downvote the article.

To support AJAX you need to load jQuery and the ``feedback.js`` in your template, i.e.::

{% load staticfiles %}
<script type="text/javascript" src=""></script>
<script type="text/javascript" src="{% static "kb/js/feedback.js" %}"></script>


Example of the app django-kb running on Openshift `here <>`_.

.. :changelog:


0.2.0 (2014-11-05)
* Add pagination in TagListView and CategoryDetailView.
* Improve admin options.

0.1.0 (2014-08-05)

* First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-kb-0.2.0.tar.gz (15.3 kB view hashes)

Uploaded source

Built Distribution

django_kb-0.2.0-py2.py3-none-any.whl (25.3 kB view hashes)

Uploaded 3 4

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page