Welcome to django-idioticon’s documentation¶

Contents:

django-idioticon¶

https://coveralls.io/repos/openpolis/django-idioticon/badge.png?branch=master

Idioticon is a module that allows to disseminate html templates with clickable question marks (idioticons)

Documentation¶

The full documentation is at https://django-idioticon.readthedocs.org.

Quickstart¶

Install django-idioticon:

pip install idioticon

Add idioticon to settings.INSTALLED_APPS, then use it in a project:

>>> import idioticon
>>> idioticon.get_term(key='not-existing-term', soft_error=True)
None

>>> term = idioticon.add_term('my-term', 'My term')
>>> idioticon.add_term('my-term', 'My term')
False

>>> idioticon.set_term('my-term', 'My new term').name
'My new term'

>>> idioticon.update_term('my-term', 'My term').name
'My term'
>>> idioticon.update_term('not-existing-term', 'My term')
False

>>> idioticon.delete_term('my-term').name
'My term'

>>> alias = idioticon.add_alias('my-term', 'my-alias', 'My alias', 'description')
>>> alias.main_term == idioticon.get_term('my-term')

Template tags¶

{% load idioticon %}
{% term 'my-term' %}

<script>
$(document).ready(function(){
    // activate popover
    $('a[rel=info-popover]').popover();
});
</script>

Features¶

Term aliases
Idioticon administration
Shortcuts ( get_term, )
Tests for Django >= 1.5 and Python >= 2.6

Installation¶

At the command line:

$ easy_install idioticon

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv idioticon
$ pip install idioticon

Usage¶

To use django-idioticon in a project:

import idioticon

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/openpolis/idioticon/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

django-idioticon could always use more documentation, whether as part of the official django-idioticon docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/openpolis/idioticon/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up idioticon for local development.

Fork the idioticon repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/idioticon.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv idioticon
$ cd idioticon/
$ python setup.py develop
```

Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ flake8 idioticon tests
$ python setup.py test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/idioticon/idioticon/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_idioticon

Credits¶

Development Lead¶

openpolis <lab@openpolis.it>
@guglielmo
@verganis
@joke2k

Contributors¶

None yet. Why not be the first?

History¶

0.1.0 (2014-01-01)¶

First release on PyPI.