Metadata-Version: 1.1
Name: django-siteflags
Version: 1.2.0
Summary: Reusable application for Django allowing users to flag/bookmark site objects
Home-page: https://github.com/idlesign/django-siteflags
Author: Igor `idle sign` Starikov
Author-email: idlesign@yandex.ru
License: BSD 3-Clause License
Description: django-siteflags
        ================
        https://github.com/idlesign/django-siteflags
        
        .. image:: https://idlesign.github.io/lbc/py2-lbc.svg
           :target: https://idlesign.github.io/lbc/
           :alt: LBC Python 2
        
        ----
        
        .. image:: https://img.shields.io/pypi/v/django-siteflags.svg
            :target: https://pypi.python.org/pypi/django-siteflags
        
        .. image:: https://img.shields.io/pypi/l/django-siteflags.svg
            :target: https://pypi.python.org/pypi/django-siteflags
        
        .. image:: https://img.shields.io/coveralls/idlesign/django-siteflags/master.svg
            :target: https://coveralls.io/r/idlesign/django-siteflags
        
        .. image:: https://img.shields.io/travis/idlesign/django-siteflags/master.svg
            :target: https://travis-ci.org/idlesign/django-siteflags
        
        
        Description
        -----------
        
        *Reusable application for Django allowing users to flag/bookmark site objects*
        
        So you want a user to be able to put some flags on certain site entities.
        
        Let's say you need a kind of bookmark powered service, or a site where content is flagged and moderated,
        or a simplified rating system, or something similar.
        
        Inherit you model from ``siteflags.models.ModelWithFlag`` and you're almost done.
        
        Like that:
        
        .. code-block:: python
        
            # myapp/models.py
            from siteflags.models import ModelWithFlag
        
        
            class Article(ModelWithFlag):
        
                ...  # Some model fields here.
        
        
        And like so:
        
        .. code-block:: python
        
            # myapp/views.py
            from django.shortcuts import get_object_or_404
            from .models import Article
        
        
            def article_details(request, article_id):
        
                article = get_object_or_404(Article, pk=article_id)
        
                user = request.user
                article.set_flag(user)
                article.is_flagged(user)
                article.remove_flag(user)
                
                ...
        
        
        Quite simple. Quite generic. Read the documentation.
        
        
        Documentation
        -------------
        
        http://django-siteflags.readthedocs.org/
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: BSD License
