معرفی شرکت ها
django-notify-x-0.1.9
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Notification sytem for Django
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | django-notify-x-0.1.9 |
| نام | django-notify-x |
| نسخه کتابخانه | 0.1.9 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Vikas Yadav |
| ایمیل نویسنده | v1k45x@gmail.com |
| آدرس صفحه اصلی | https://github.com/v1k45/django-notify-x |
| آدرس اینترنتی | https://pypi.org/project/django-notify-x/ |
| مجوز | The MIT License |
============================
django-notify-x: quick guide
============================
.. image:: https://readthedocs.org/projects/django-notify-x/badge/?version=latest
:target: http://django-notify-x.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://badge.fury.io/py/django-notify-x.svg
:target: https://badge.fury.io/py/django-notify-x
.. image:: https://travis-ci.org/v1k45/django-notify-x.svg
:target: https://travis-ci.org/v1k45/django-notify-x
Django NotifyX is a reusable app which adds notification system features to your Django app.
It was inspired from `django-notifications`_ , major differences include:
- Multipe user notification at once.
- A different approach for notification updates.
- Less hassles when trying to format notifications differently according to their types.
- AJAX support for everything.
- And many more.
This is just a quick guide to get things to work ASAP. To dive into the details.. `Read the docs`_
How to install
==============
Downloading the package
-----------------------
Probably the best way to install is by using `PIP`::
$ pip install django-notify-x
If you want to stay on the bleeding edge of the app::
$ git clone https://github.com/v1k45/django-notify-x.git
$ cd django-notify-x
$ python setup.py install
Installing it on your project
-----------------------------
After the you've installed ``django-notify-x`` in your python enviroment. You have to make an entry of the same in your project ``settings.py`` file::
INSTALLED_APPS = (
...
'your.other.apps',
...
'notify',
)
Then an entry on the ``urls.py`` file::
urlpatterns = (
url(r'^notifications/', include('notify.urls', 'notifications')),
)
Then run migrations::
$ python manage.py migrate notify
Then ``collectstatic`` to make sure you've copied the JS file for AJAX functionality::
$ python manage.py collectstatic
You've successfully installed ``django-notify-x``!
Sending notifications
=====================
Sending notifications to a single user:
---------------------------------------
.. code-block:: python
from notify.signals import notify
# your example view
def follow_user(request, user):
user = User.objects.get(username=user)
...
dofollow
...
notify.send(request.user, recipient=user, actor=request.user
verb='followed you.', nf_type='followed_by_one_user')
return YourResponse
Easy as pie, isn't it?
Sending notifications to multiple users:
----------------------------------------
.. code-block:: python
from notify.signals import notify
# your example view
def upload_video(request):
...
uploadvideo...
...
video = VideoUploader.getupload()
followers = list(request.user.followers())
notify.send(request.user, recipient_list=followers, actor=request.user
verb='uploaded.', target=video, nf_type='video_upload_from_following')
return YourResponse
Just change the ``recipient`` to ``recipient_list`` and send notifications to as many users you want!
.. warning::
``recipient_list`` expects supplied object to be a list() instance, make sure you convert your ``QuerySet`` to list() before assigning vaule.
Notification concatenation support
----------------------------------
Notification Concatenation is what you see when you read notifications like **Bob and 64 others liked your status**. A developmental support is available for it, but it only supports Python3 for now.
If you use Python3, you can add this feature to your application.
Please read instructions on `nf_concat_support <https://github.com/v1k45/django-notify-x/tree/nf_concat_support>`__ branch.
Notification Template tags
==========================
This app comes with two notification tags, one renders notifications for you and the other includes javascript variables and functions relating the ``notifyX.js`` file.
render_notifications
--------------------
As its name reflects, it will render notifications for you. ``render_notifications`` will take at least one parameter and maximum two parameters.
You can use them to render notifications using a ``Notification`` QuerySet object, like this::
{% load notification_tags %}
{% render_notifications using request.user.notifications.active %}
By default, the above tag will render notifications on the notifications page and not on the notification box. So it will use a template corresponing to it's ``nf_type`` with a ``.htm`` suffix nothing more.
To render notificatons on a notifications box::
{% load notification_tags %}
{% render_notifications using request.user.notifications.active for box %}
This tag will look for template name with ``_box.html`` suffixed when rendering notification contents.
The ``request.user.notifications.active`` is just used to show an example of notification queryset, you can use any other way to supply a QuerySet of your choice.
include_notify_js_variables
---------------------------
This tag uses ``notifications/includes/js_variables.html`` to include a template populated with JS variables and functions. You can override the values of any JS variables by creating your own version of ``js_variables.html`` template.
To include JS variables for AJAX notification support, do this::
{% load notification_tags %}
{% include_notify_js_variables %}
This template inclusion includes three javascript files from the template includes directory, they are::
mark_success.js
mark_all_success.js
delete_success.js
update_success.js
All of them are nothing but javascript function declarations which are supposed to run when a JQuery AJAX request is successfully completed.
user_notifications
------------------
The ``user_notifications`` tag is a shortcut to the ``render_notifications`` tag. It directly renders the notifications of the logged-in user on the specified target.
You can use this tag like this::
{% load notification_tags %}
{% user_notifications %}
This tag renders active notifications of the user by using something like ``request.user.notifications.active()``.
Just like ``render_notifications`` it also takes rendering target as an optional argument. You can specify rendering target like this::
{% load notification_tags %}
{% user_notifications for box %}
By default, it'll use 'page' as the rendering target and use full page notification rending template corresponding to the ``nf_type`` of the template.
And other things...
===================
It will be best to `Read the Docs`_ instead of expecting every thing from a quick guide :)
TODO List
=========
- Add notification concatenation support.
- Notification concatenation is what facebook does when you read a notification like *Bob and 18 others commented on your blogpost*.
- This will require non-anonymous activity stream field.
- I've to either remove the anonymous notification support or find another way to implement this feature.
- **work in progress!**
- Convert *Function based views* to *Class Based views*.
.. _django-notifications: https://www.github.com/django-notifications/django-notifications/
.. _Read the docs: http://django-notify-x.readthedocs.org/en/latest/index.html
نحوه نصب
نصب پکیج whl django-notify-x-0.1.9:
pip install django-notify-x-0.1.9.whl
نصب پکیج tar.gz django-notify-x-0.1.9:
pip install django-notify-x-0.1.9.tar.gz