{ "info": { "author": "alireza molaee", "author_email": "alirezamolaii@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU General Public License (GPL)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.4", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Django webline Notifications\n===========================\n###Screen shot\n![screen shot](http://i.imgur.com/TxoZeaG.png)\n\n###What is Django webline Notifications\nThis is a django application to notify user about events.\nYou can simply inform user about all kind of updates.\n\n###Features\n * Chose notification status and color\n * Thumbnail for notification\n * Notification has a URL, can passed in other notifications\n * Send group (to list of users) notification\n \n##How to install\n###Downloading the package\nProbably the best way to install is by using PIP:\n\n```\n$ pip install django-webline-notifications\n```\nIf you want to clone the main repository:\n\n```\n$ git clone https://github.com/alireza-molaee/django-webline-notifications.git\n$ cd django-webline-notifications\n$ python setup.py install\n```\n###install on django\nnow you can add django-simple-notifications to the settings.py file:\n\n```\nINSTALLED_APPS = (\n ...\n 'webline-notifications',\n 'django.contrib.admin',\n)\n```\nThen run migrations:\n\n```\n$ python manage.py migrate webline-notifications\n```\nThen collectstatic:\n\n```\n$ python manage.py collectstatic\n```\nnow if run server you can see notifications in django admin:\n\n```\n$ python manage.py runserver\n```\n##Settings\nyou can limit archive notification for all user by `WEBLINE_NOTIFICATIONS_LIMIT` default is `False` it mean (no limit)\nfor example `myproject.settings.py`:\n\n```\n... \nWEBLINE_NOTIFICATIONS_LIMIT = 50 \n...\n```\n\n##Usage\nto notify every thing you want:\n\n 1. import Notification\n 2. use Notification.send to send notification\n\n```\nfrom webline_notification.model import Notification\n\nNotification.send(\n\t...\n)\n```\n#####send option:\n\n 1. list of user: \n\tlist of user object that you want to receive this notification `[obj, obj, ...]`\n 2. content: \n\ta small text about event `'some one join us'`\n 3. icon: \n\ticon css class `'fa-info'`\n 4. color: \n\tcolor hex id `'#c3c3c3'`\n 5. link: \n\tyou notification can have a url to where reason of event `'http://www.google.com/'` *(optional)*\n \t\nyou can use default color in Notification `Notification.COLOR_DANGER`\nyou can filter notification by color in django admin if you use default color\n\n#####defult colors: \n\n* COLOR_WARNING\n* COLOR_DANGER\n* COLOR_INFO\n* COLOR_SUCCESS\n* COLOR_PRIMARY\n* COLOR_GRAY\n* COLOR_BLACK\n\n#####example:\n\n```\nfrom webline_notifications.models import Notification\nfrom django.contrib.auth.models import User\n\nuser = User.objects.get(pk=1)\n\nNotification.send(\n [user],\n 'foo',\n 'fa-info',\n Notification.COLOR_DANGER,\n url='http://www.google.com/'\n )\n```\n\n\n \t\n##TODO\n- [x] add test for models\n- [x] add template tags to use any template\n- [x] add view to change see status\n- [x] add test for view \n- [ ] add default settings\n - [ ] font files\n - [x] default notification count to show\n - [x] max of notification can be archived\n- [x] handle events by AJAX", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/alireza-molaee/django-webline-notifications", "keywords": "", "license": "GNU General Public License (GPL)", "maintainer": "", "maintainer_email": "", "name": "django-webline-notifications", "package_url": "https://pypi.org/project/django-webline-notifications/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-webline-notifications/", "project_urls": { "Homepage": "https://github.com/alireza-molaee/django-webline-notifications" }, "release_url": "https://pypi.org/project/django-webline-notifications/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "A simple Django app which allow you notify everything to user or users", "version": "1.0.1" }, "last_serial": 1882665, "releases": { "1.0": [], "1.0.1": [ { "comment_text": "", "digests": { "md5": "1ad4cdbc5c0f2677578a817ad1371e34", "sha256": "7bf05572d40a659feadae366af78a9e6dde040f6c16cc38ed05be6bfb2988918" }, "downloads": -1, "filename": "django-webline-notifications-1.0.1.tar.gz", "has_sig": false, "md5_digest": "1ad4cdbc5c0f2677578a817ad1371e34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 496659, "upload_time": "2015-12-30T19:01:43", "url": "https://files.pythonhosted.org/packages/47/ed/0bc0cf74c0b9b586f2afbac0f6b50b226ff3ca2f5dc0132ddcd9fff3b3bf/django-webline-notifications-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1ad4cdbc5c0f2677578a817ad1371e34", "sha256": "7bf05572d40a659feadae366af78a9e6dde040f6c16cc38ed05be6bfb2988918" }, "downloads": -1, "filename": "django-webline-notifications-1.0.1.tar.gz", "has_sig": false, "md5_digest": "1ad4cdbc5c0f2677578a817ad1371e34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 496659, "upload_time": "2015-12-30T19:01:43", "url": "https://files.pythonhosted.org/packages/47/ed/0bc0cf74c0b9b586f2afbac0f6b50b226ff3ca2f5dc0132ddcd9fff3b3bf/django-webline-notifications-1.0.1.tar.gz" } ] }