eim-comments 0.1

Reusable comments app for learning purposes.

Reusable comments app for learning purposes.

Installation

To get the latest stable release from PyPi

pip install eim-comments

To get the latest commit from GitHub

pip install -e git+git://github.com/EimantasSl/eim-comments.git#egg=eim_comments

TODO: Describe further installation steps (edit / remove the examples below):

Add eim_comments to your INSTALLED_APPS

INSTALLED_APPS = (
    ...,
    'eim_comments',
)

Add the eim_comments URLs to your urls.py

urlpatterns = patterns('',
    ...
    url(r'^/', include('eim_comments.urls')),
)

Before your tags/filters are available in your templates, load them by using

{% load eim_comments_tags %}

Don’t forget to migrate your database

./manage.py migrate eim_comments

Usage

TODO: Describe usage or point to docs. Also describe available settings and templatetags.

Contribute

If you want to contribute to this project, please perform the following steps

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 eim-comments
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch

In order to run the tests, simply execute tox. This will install two new environments (for Django 1.8 and Django 1.9) and run the tests against both environments.