Skip to main content

Simple knowledge base made with django

Project description

=============================
Django KB
=============================

.. image:: https://pypip.in/version/django-kb/badge.svg
:target: https://pypi.python.org/pypi/django-kb/
:alt: Latest Version

.. image:: https://pypip.in/py_versions/django-kb/badge.svg
:target: https://pypi.python.org/pypi/django-kb/
:alt: Supported Python versions

.. image:: https://pypip.in/format/django-kb/badge.svg
:target: https://pypi.python.org/pypi/django-kb/
:alt: Download format

.. image:: https://travis-ci.org/eliostvs/django-kb.png?branch=master
:target: https://travis-ci.org/eliostvs/django-kb

.. image:: https://coveralls.io/repos/eliostvs/django-kb/badge.png?branch=master
:target: https://coveralls.io/r/eliostvs/django-kb?branch=master

Simple knowledge base made with django

Installation
-------------

#. 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 ``urls.py`` file with namespaece ``kb``::

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

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

MIDDLEWARE_CLASSES = (
...
"kb.middleware.KnowledgeMiddleware",
)

Usage
-----

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="http://code.jquery.com/jquery.min.js"></script>
<script type="text/javascript" src="{% static "kb/js/feedback.js" %}"></script>


Example
-------

Example of the app django-kb running on Openshift `here <https://github.com/eliostvs/django-kb-example>`_.


.. :changelog:

History
-------

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_kb-0.2.0-py2.py3-none-any.whl (25.3 kB) Copy SHA256 hash SHA256 Wheel 3.4 Aug 12, 2014
django-kb-0.2.0.tar.gz (15.3 kB) Copy SHA256 hash SHA256 Source None Aug 12, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page