Metadata-Version: 1.1
Name: django-hvad
Version: 1.0.0
Summary: A content translation framework for django integrated automatically in the normal ORM. Removes the pain of having to think about translations in a django project.
Home-page: https://github.com/KristianOellegaard/django-hvad
Author: Kristian Ollegaard
Author-email: kristian.ollegaard@divio.ch
License: UNKNOWN
Description: ========================================
        django-hvad |package| |coverage| |build|
        ========================================
        
        **Model translations made easy.**
        
        This project adds support for model translations in Django. It is designed to be
        unobtrusive, efficient and reliable. On the technical side, it uses an automatically
        created `Translations Model` to store translatable fields in arbitrary
        languages with a foreign key to the main model, enabling fast queries.
        
        Started in 2011, hvad has grown mature and is now used on large scale applications.
        
        Quick links:
        
        - `Documentation`_.
        - `Release notes`_.
        - `Issue tracker`_.
        
        Features
        --------
        
        * **Simple** - only 3 new queryset methods.
        * **Natural** - use Django ORM as usual, it just became language aware.
        * **Fast** - no additional queries for reads, just an inner join to an indexed key.
        * **Complete** - supports relationships, custom managers, proxy models, and abstract models.
        * **Batteries included** - translation-enabled forms and admin are provided.
        * **Reliable** - more than 270 test cases and counting. |coverage| |build|
        * **Compatible** with Django 1.4 to 1.7, running Python 2.7, 3.3 or 3.4.
        
        Releases
        --------
        
        Django-hvad uses the same release pattern as Django. The following versions
        are thus available:
        
        * Stable branch 0.4, available through `PyPI`_ and git branch ``releases/0.4.x``.
        * Stable branch 0.5, available through `PyPI`_ and git branch ``releases/0.5.x``.
        * Stable branch 1.0, available through `PyPI`_ and git branch ``releases/1.0.x``.
        * Development branch 1.1, available through git branch ``master``.
        
        Stable branches have minor bugfix releases as needed, with guaranteed compatibility.
        See the `installation guide`_ for details, or have a look at the `release notes`_.
        
        Example Use
        -----------
        
                     Book.objects.all()
        
        Compatible by default: returns all objects, without any translated fields attached.
        Starting from v1.0, default behavior can be overriden to work like next query:
        
                     Book.objects.language().all()
        
        Returns all objects as translated instances, but only the ones that are translated
        into the currect language. You can also specify which language to get, using e.g.:
        
                     Book.objects.language("en").all()
        
        Usual queryset methods work as usual: let's get all books as translated instances,
        filtering on the translatable ``title`` attribute, returning those that have
        ``Petit Prince`` in their French title, ordered by publication date (in their
        French edition):
        
                     Book.objects.language("fr").filter(title__contains='Petit Prince').order_by('release')
        
        Other random examples:
        
                    # last German book published in year 1948
                    Book.objects.language("de").filter(release__year=1948).latest()
        
                    # other books from the same author as mybook. Cache author as well.
                    Book.objects.language().select_related('author').filter(author__books=mybook)
        
                    # books that have "Django" in their title, regardless of the language
                    Book.objects.language('all').filter(title__icontains='Django')
        
        
        More examples in the `quickstart guide`_.
        
        Thanks to
        ---------
        
        Jonas Obrist (https://github.com/ojii) for making django-nani and for helping me with this project.
        
        .. |package| image:: https://badge.fury.io/py/django-hvad.svg
                             :target: https://pypi.python.org/pypi/django-hvad
        .. |build| image:: https://secure.travis-ci.org/KristianOellegaard/django-hvad.png?branch=master
        .. |coverage| image:: https://coveralls.io/repos/KristianOellegaard/django-hvad/badge.png
                              :target: https://coveralls.io/r/KristianOellegaard/django-hvad
        
        .. _documentation: http://django-hvad.readthedocs.org/
        .. _release notes: https://django-hvad.readthedocs.org/en/latest/public/release_notes.html
        .. _issue tracker: https://github.com/KristianOellegaard/django-hvad/issues
        .. _PyPI: https://pypi.python.org/pypi/django-hvad
        .. _installation guide: http://django-hvad.readthedocs.org/en/latest/public/installation.html
        .. _quickstart guide: http://django-hvad.readthedocs.org/en/latest/public/quickstart.html
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Text Processing :: Linguistic
