Skip to main content

A small, rudimentary helper app for RiotJS integration into django projects.

Project description

A small, rudimentary helper app for RiotJS (https://riot.js.org) integration into django projects.

Quickstart

Install Django RiotJS Helper:

pip install django-riotjs-helper

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'riotjs_helper',
    ...
)

Add this to your base template (base.html):

{% include 'riotjs_helper/riotjs_core.html' %}
{% block riot_tags %}
{% endblock riot_tags %}
{% include 'riotjs_helper/riotjs_mount.html' %}

If you plan on using django rest framework you can switch riotjs_core.html to the more elaborate riotjs_setup.html:

{% include 'riotjs_helper/riotjs_setup.html' %}

This setup requires some additional libraries as well, allready included in the requirements.txt:

djangorestframework
django-filter
django-rest-swagger
httpie
Markdown
python-dateutil
coreapi
coreapi-cli
coreschema

And these has to be added to your INSTALLED_APPS, urls has to be updated etc.

And then to create some tags:

python manage.py riot_tag <appname> <tag1-name> <tag2-name>

In the page you want to use your tag:

{% block content %}
...
<tag1-name></tag1-name>
...
<tag2-name></tag2-name>
...
{% endblock %}

{% block riot_tags %}
{% include '<appname>/include/<tag1-name>_tag.html' %}
{% include '<appname>/include/<tag2-name>_tag.html' %}
{% endblock riot_tags %}

If you need to add more context to your tags you can do that by editing the generated include files, for instance like so:

{% load static %}
<script src="{% static '<appname>/tags/<tag1-name>.tag' %}" type="riot/tag"></script>
<script>

riot_context['<tag1-name>'] = {more_context_goes_here: { ... something fancy ...}};

</script>

If you want to look at some boilerplate/example code generate your tags with the –example-code option:

python manage.py riot_tag <appname> <tag1-name> <tag2-name> --example-code

History

0.1.0 (2018-09-23)

  • 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.

Files for django-riotjs-helper, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size django_riotjs_helper-0.1.1-py2.py3-none-any.whl (6.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-riotjs-helper-0.1.1.tar.gz (7.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page