Metadata-Version: 2.1
Name: django-i18next
Version: 0.1.3
Summary: Additions to Django's i18n module.
Home-page: https://github.com/barseghyanartur/django-i18next/
Author: Artur Barseghyan
Author-email: artur.barseghyan@gmail.com
License: GPL 2.0/LGPL 2.1
Keywords: django,i18n,internationalisation
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
License-File: LICENSE_GPL2.0.txt
License-File: LICENSE_LGPL_2.1.txt

==============
django-i18next
==============
`django-i18next` - Additions to Django's i18n module.

Prerequisites
=============
- Django 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10
- Python >= 2.6.8, >= 2.7, >= 3.4

Roadmap
=======
See the `TODOS <https://raw.githubusercontent.com/barseghyanartur/django-i18next/master/TODOS.rst>`_
for the full list of planned-, pending- in-development- or to-be-implemented
features.

Installation
============

(1) Install latest stable version from PyPI:

.. code-block:: sh

    pip install django-i18next

Or latest stable version from GitHub:

.. code-block:: sh

    pip install -e git+https://github.com/barseghyanartur/django-i18next@stable#egg=django-i18next

Or latest stable version from BitBucket:

.. code-block:: sh

    pip install -e hg+https://bitbucket.org/barseghyanartur/django-i18next@stable#egg=django-i18next

(2) Add `i18next` to ``INSTALLED_APPS`` of the your projects' Django settings.

.. code-block:: python

    INSTALLED_APPS = (
        # ...
        'i18next',

        # Other project specific apps
        'foo', # Test app
        # ...
    )

Usage
=====
Override locale
---------------
No matter what your current locale is, you can override it for a certain part
of your template using the ``overridelocale`` template tag.

Load the templatetags.

.. code-block:: html

    {% load i18n i18next %}

The following code forces Dutch locale for whatever is put inside the
``overridelocale`` block.

.. code-block:: html

    {% overridelocale 'nl' %}
        <p>
            <a href="/login/">{% trans "Log in" %}</a>
        </p>
    {% endoverridelocale %}

The following code forces Russian locale for whatever is put inside the
``overridelocale`` block.

.. code-block:: html

    {% overridelocale 'ru' %}
        <p>
            <a href="/login/">{% trans "Log in" %}</a>
        </p>
    {% endoverridelocale %}

The following code forces English locale for whatever is put inside the
``overridelocale`` block.

.. code-block:: html

    {% overridelocale 'en' %}
        <p>
            <a href="/login/">{% trans "Log in" %}</a>
        </p>
    {% endoverridelocale %}

Disable translations
--------------------
No matter what your current locale is, you can disable translations for a
certain part of your template using the ``disabletranslations`` template tag.

.. code-block:: html

    {% load i18n i18next %}

    {% disabletranslations %}
        <p>
            <a href="/login/">{% trans "Log in" %}</a>
        </p>
    {% enddisabletranslations %}

Demo
====
Live demo
---------
See the `live demo app <https://django-i18next.herokuapp.com/nl/>`_ on Heroku.

Run demo locally
----------------
In order to be able to quickly evaluate the `django-i18next`, a demo app (with
a quick installer) has been created (works on Ubuntu/Debian, may work on other
Linux systems as well, although not guaranteed). Follow the instructions below
for having the demo running within a minute.

Grab the latest `django_i18next_example_app_installer.sh`:

.. code-block:: sh

    wget https://raw.github.com/barseghyanartur/django-i18next/stable/examples/django_i18next_example_app_installer.sh

Assign execute rights to the installer and run the
`django_i18next_example_app_installer.sh`:

.. code-block:: sh

    chmod +x django_i18next_example_app_installer.sh
    ./django_i18next_example_app_installer.sh

Open your browser and test the app.

- URL: http://127.0.0.1:8001/nl/

If quick installer doesn't work for you, see the manual steps on running the
`example project
<https://github.com/barseghyanartur/django-i18next/tree/stable/examples>`_.

Debugging
=========
By default debugging is turned off. Set the ``I18NEXT_DEBUG`` to True
in the ``settings.py`` of your project in order to do so.

License
=======
GPL 2.0/LGPL 2.1

Support
=======
For any issues contact me at the e-mail given in the `Author` section.

Author
======
Artur Barseghyan <artur.barseghyan@gmail.com>


