Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhiabhi94/django-flag-app
A pluggable django application that adds the ability for users to flag(or report) your models.
https://github.com/abhiabhi94/django-flag-app
django django-rest-framework flag moderation report
Last synced: 2 months ago
JSON representation
A pluggable django application that adds the ability for users to flag(or report) your models.
- Host: GitHub
- URL: https://github.com/abhiabhi94/django-flag-app
- Owner: abhiabhi94
- License: mit
- Created: 2020-09-15T18:19:24.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T00:09:11.000Z (4 months ago)
- Last Synced: 2024-11-06T21:08:35.995Z (3 months ago)
- Topics: django, django-rest-framework, flag, moderation, report
- Language: Python
- Homepage:
- Size: 1.05 MB
- Stars: 14
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
===============
django-flag-app
===============
.. image:: https://github.com/abhiabhi94/django-flag-app/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/abhiabhi94/django-flag-app/actions
:alt: Test
.. image:: https://codecov.io/gh/abhiabhi94/django-flag-app/branch/main/graph/badge.svg?token=1XFNVKMX4W
:target: https://codecov.io/gh/abhiabhi94/django-flag-app
:alt: Coverage
.. image:: https://badge.fury.io/py/django-flag-app.svg
:target: https://pypi.org/project/django-flag-app/
:alt: Latest PyPi version
.. image:: https://img.shields.io/pypi/pyversions/django-flag-app.svg
:target: https://pypi.python.org/pypi/django-flag-app/
:alt: python
.. image:: https://img.shields.io/pypi/djversions/django-flag-app.svg
:target: https://pypi.python.org/pypi/django-flag-app/
:alt: django
.. image:: https://readthedocs.org/projects/django-flag-app/badge/?version=latest
:target: https://django-flag-app.readthedocs.io/?badge=latest
:alt: docs
.. image:: https://img.shields.io/github/license/abhiabhi94/django-flag-app?color=gr
:target: https://github.com/abhiabhi94/django-flag-app/blob/main/LICENSE
:alt: licence
A pluggable django application that adds the ability for users to flag(report or moderate) your models.
.. image:: https://raw.githubusercontent.com/abhiabhi94/django-flag-app/main/docs/_static/images/django-flag-app.gif
:alt: flagging-process
For complete documentation you may visit `Read the Doc`_. or see the `docs`_ directory.
.. _Read the Doc: https://django-flag-app.readthedocs.io
.. _docs: https://github.com/abhiabhi94/django-flag-app/blob/main/docs/
Installation
------------
Install using ``pip``
.. code:: sh
$ pip install django-flag-app
If you want, you may install it from the source, grab the source code and run ``setup.py``.
.. code:: sh
$ git clone git://github.com/abhiabhi94/django-flag-app.git
$ cd django-flag-app
$ python setup.py install
Usage
-----
Add app
````````
To enable ``django_flag_app`` in your project you need to add it to ``INSTALLED_APPS`` in your projects ``settings.py`` file:
.. code:: python
INSTALLED_APPS = (
...
'flag',
...
)
Add URL
````````
In your root ``urls.py``:
.. code:: python
urlpatterns = patterns(
path('admin/', admin.site.urls),
path('flag/', include('flag.urls')),
...
path('api/', include('flag.api.urls')), # only required for API Framework
...
)
Migrate
````````
Run the migrations to add the new models to your database:
.. code:: sh
python manage.py migrate flag
Connect the flag model with the target model
`````````````````````````````````````````````
In ``models.py`` add the field ``flags`` as a ``GenericRelation`` field to the required model.
E.g. for a ``Post`` model, you may add the field as shown below:
.. code:: python
from django.contrib.contenttypes.fields import GenericRelation
from flag.models import Flag
class Post(models.Model):
user = models.ForeignKey(User)
title = models.CharField(max_length=200)
body = models.TextField()
# the field name should be flags
flags = GenericRelation(Flag)
.. important::
the name of the field should be **flags**.
Use template tag
`````````````````
If you want to use web API, this step is not required. See further instructions at `Web API`_.
.. _Web API: https://github.com/abhiabhi94/django-flag-app/blob/main/docs/webAPI.rst
``render_flag_form`` tag requires 3 required positional arguments:
1. Instance of the targeted model.
2. User object.
3. Request object
To render the ``flag`` form for a the instance ``post``, place this inside your detail view, perhaps in some template of the sort ``postdetail.html``.
.. code:: jinja
{% render_flag_form post user request %}
Contributing
------------
Please see the instructions at `Contributing.rst`_.
.. _Contributing.rst: https://github.com/abhiabhi94/django-flag-app/blob/main/CONTRIBUTING.rst