Metadata-Version: 1.1
Name: django-siteflags
Version: 0.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://badge.fury.io/py/django-siteflags.png
            :target: http://badge.fury.io/py/django-siteflags
        
        .. image:: https://pypip.in/d/django-siteflags/badge.png
                :target: https://crate.io/packages/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 django.db import models
            from siteflags.models import ModelWithFlag
        
        
            class Article(models.Model, 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, id):
        
                article = get_object_or_404(Article, pk=id)
        
                ...
        
                # Now a user adds this article to his bookmarks.
                article.set_flag(request.user)
        
                ...
        
        
        Quite simple.
        
        
        Documentation
        -------------
        
        http://django-siteflags.readthedocs.org/
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
