{"id":13758116,"url":"https://github.com/v1k45/django-notify-x","last_synced_at":"2026-01-17T02:03:47.110Z","repository":{"id":57421045,"uuid":"47825136","full_name":"v1k45/django-notify-x","owner":"v1k45","description":"Notification system for Django","archived":false,"fork":false,"pushed_at":"2023-11-09T10:24:22.000Z","size":139,"stargazers_count":187,"open_issues_count":16,"forks_count":39,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-20T07:52:16.032Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/v1k45.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst"}},"created_at":"2015-12-11T12:17:19.000Z","updated_at":"2025-05-11T09:38:49.000Z","dependencies_parsed_at":"2024-01-15T03:42:40.143Z","dependency_job_id":null,"html_url":"https://github.com/v1k45/django-notify-x","commit_stats":{"total_commits":87,"total_committers":6,"mean_commits":14.5,"dds":"0.33333333333333337","last_synced_commit":"c8828c1c0c550b7b33acccb4db51fc612045afa3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/v1k45/django-notify-x","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v1k45%2Fdjango-notify-x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v1k45%2Fdjango-notify-x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v1k45%2Fdjango-notify-x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v1k45%2Fdjango-notify-x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/v1k45","download_url":"https://codeload.github.com/v1k45/django-notify-x/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/v1k45%2Fdjango-notify-x/sbom","scorecard":{"id":913978,"data":{"date":"2025-08-11","repo":{"name":"github.com/v1k45/django-notify-x","commit":"c8828c1c0c550b7b33acccb4db51fc612045afa3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":2,"reason":"Found 5/17 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"22 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2018-6 / GHSA-2f9x-5v75-3qv4","Warn: Project is vulnerable to: PYSEC-2017-9 / GHSA-37hp-765x-j95x","Warn: Project is vulnerable to: PYSEC-2016-18 / GHSA-3f2c-jm6v-cr35","Warn: Project is vulnerable to: PYSEC-2021-98 / GHSA-68w8-qjq3-2gfm","Warn: Project is vulnerable to: PYSEC-2015-11 / GHSA-6wcr-wcqm-3mfh","Warn: Project is vulnerable to: PYSEC-2015-19 / GHSA-6wgp-fwfm-mxp3","Warn: Project is vulnerable to: GHSA-7xr5-9hcq-chf9","Warn: Project is vulnerable to: GHSA-8x94-hmjh-97hq","Warn: Project is vulnerable to: PYSEC-2016-2 / GHSA-c8c8-9472-w52h","Warn: Project is vulnerable to: PYSEC-2015-21 / GHSA-cqf7-ff9h-7967","Warn: Project is vulnerable to: PYSEC-2016-3 / GHSA-crhm-qpjc-cm64","Warn: Project is vulnerable to: PYSEC-2016-16 / GHSA-fp6p-5xvw-m74f","Warn: Project is vulnerable to: PYSEC-2017-10 / GHSA-h4hv-m4h4-mhwg","Warn: Project is vulnerable to: PYSEC-2015-20 / GHSA-h582-2pch-3xv3","Warn: Project is vulnerable to: GHSA-hmr4-m2h5-33qx","Warn: Project is vulnerable to: PYSEC-2016-17 / GHSA-mv8g-fhh6-6267","Warn: Project is vulnerable to: PYSEC-2015-22 / GHSA-pgxh-wfw4-jx2v","Warn: Project is vulnerable to: PYSEC-2016-15 / GHSA-pw27-w7w4-9qc7","Warn: Project is vulnerable to: PYSEC-2015-10 / GHSA-q5qw-4364-5hhm","Warn: Project is vulnerable to: PYSEC-2018-5 / GHSA-r28v-mw67-m5p9","Warn: Project is vulnerable to: GHSA-rrqc-c2jx-6jgv","Warn: Project is vulnerable to: PYSEC-2019-16 / GHSA-vfq6-hq5r-27r6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T20:18:34.861Z","repository_id":57421045,"created_at":"2025-08-24T20:18:34.861Z","updated_at":"2025-08-24T20:18:34.861Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T00:50:05.742Z","status":"online","status_checked_at":"2026-01-17T02:00:07.808Z","response_time":85,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T12:01:01.203Z","updated_at":"2026-01-17T02:03:47.077Z","avatar_url":"https://github.com/v1k45.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"============================\ndjango-notify-x: quick guide\n============================\n\n.. image:: https://readthedocs.org/projects/django-notify-x/badge/?version=latest\n   :target: http://django-notify-x.readthedocs.org/en/latest/?badge=latest\n   :alt: Documentation Status\n\n.. image:: https://badge.fury.io/py/django-notify-x.svg\n   :target: https://badge.fury.io/py/django-notify-x\n\n.. image:: https://travis-ci.org/v1k45/django-notify-x.svg\n   :target: https://travis-ci.org/v1k45/django-notify-x\n\n\nDjango NotifyX is a reusable app which adds notification system features to your Django app.\n\nIt was inspired from `django-notifications`_ , major differences include:\n    - Multipe user notification at once.\n    - A different approach for notification updates.\n    - Less hassles when trying to format notifications differently according to their types.\n    - AJAX support for everything.\n    - And many more.\n\nThis is just a quick guide to get things to work ASAP. To dive into the details.. `Read the docs`_\n\nHow to install\n==============\n\nDownloading the package\n-----------------------\n\nProbably the best way to install is by using `PIP`::\n\n    $ pip install django-notify-x\n\nIf you want to stay on the bleeding edge of the app::\n\n    $ git clone https://github.com/v1k45/django-notify-x.git\n    $ cd django-notify-x\n    $ python setup.py install\n\nInstalling it on your project\n-----------------------------\n\nAfter 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::\n\n    INSTALLED_APPS = (\n        ...\n        'your.other.apps',\n        ...\n        'notify',\n    )\n\nThen an entry on the ``urls.py`` file::\n\n\n    urlpatterns = (\n        url(r'^notifications/', include('notify.urls', 'notifications')),\n    )\n\nThen run migrations::\n\n    $ python manage.py migrate notify\n\nThen ``collectstatic`` to make sure you've copied the JS file for AJAX functionality::\n\n    $ python manage.py collectstatic\n\nYou've successfully installed ``django-notify-x``!\n\nSending notifications\n=====================\n\nSending notifications to a single user:\n---------------------------------------\n\n.. code-block:: python\n\n    from notify.signals import notify\n\n    # your example view\n    def follow_user(request, user):\n        user = User.objects.get(username=user)\n        ...\n        dofollow\n        ...\n\n        notify.send(request.user, recipient=user, actor=request.user\n                    verb='followed you.', nf_type='followed_by_one_user')\n\n        return YourResponse\n\n\nEasy as pie, isn't it?\n\nSending notifications to multiple users:\n----------------------------------------\n\n.. code-block:: python\n\n    from notify.signals import notify\n\n    # your example view\n    def upload_video(request):\n        ...\n        uploadvideo...\n        ...\n        video = VideoUploader.getupload()\n        followers = list(request.user.followers())\n\n        notify.send(request.user, recipient_list=followers, actor=request.user\n                    verb='uploaded.', target=video, nf_type='video_upload_from_following')\n\n        return YourResponse\n\nJust change the ``recipient`` to ``recipient_list`` and send notifications to as many users you want!\n\n.. warning::\n     ``recipient_list`` expects supplied object to be a list() instance, make sure you convert your ``QuerySet`` to list() before assigning vaule.\n\nNotification concatenation support\n----------------------------------\n\nNotification 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.\n\nIf you use Python3, you can add this feature to your application.\nPlease read instructions on `nf_concat_support \u003chttps://github.com/v1k45/django-notify-x/tree/nf_concat_support\u003e`__ branch.\n\nNotification Template tags\n==========================\n\nThis app comes with two notification tags, one renders notifications for you and the other includes javascript variables and functions relating the ``notifyX.js`` file.\n\nrender_notifications\n--------------------\n\n    As its name reflects, it will render notifications for you. ``render_notifications`` will take at least one parameter and maximum two parameters.\n\n    You can use them to render notifications using a ``Notification`` QuerySet object, like this::\n\n        {% load notification_tags %}\n        {% render_notifications using request.user.notifications.active %}\n\n    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.\n\n    To render notificatons on a notifications box::\n        \n        {% load notification_tags %}\n        {% render_notifications using request.user.notifications.active for box %}\n\n    This tag will look for template name with ``_box.html`` suffixed when rendering notification contents.\n\n    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.\n\ninclude_notify_js_variables\n---------------------------\n\n    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.\n\n    To include JS variables for AJAX notification support, do this::\n\n        {% load notification_tags %}\n        {% include_notify_js_variables %}\n\n    This template inclusion includes three javascript files from the template includes directory, they are::\n\n        mark_success.js\n        mark_all_success.js\n        delete_success.js\n        update_success.js\n\n    All of them are nothing but javascript function declarations which are supposed to run when a JQuery AJAX request is successfully completed.\n\nuser_notifications\n------------------\n\n    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.\n\n    You can use this tag like this::\n\n        {% load notification_tags %}\n        {% user_notifications %}\n\n    This tag renders active notifications of the user by using something like ``request.user.notifications.active()``.\n\n    Just like ``render_notifications`` it also takes rendering target as an optional argument. You can specify rendering target like this::\n\n        {% load notification_tags %}\n        {% user_notifications for box %}\n\n    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.\n\nAnd other things...\n===================\n\nIt will be best to `Read the Docs`_ instead of expecting every thing from a quick guide :)\n\nTODO List\n=========\n\n- Add notification concatenation support.\n    - Notification concatenation is what facebook does when you read a notification like *Bob and 18 others commented on your blogpost*.\n    - This will require non-anonymous activity stream field.\n    - I've to either remove the anonymous notification support or find another way to implement this feature.\n    - **work in progress!**\n- Convert *Function based views* to *Class Based views*.\n\n.. _django-notifications: https://www.github.com/django-notifications/django-notifications/\n.. _Read the docs: http://django-notify-x.readthedocs.org/en/latest/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fv1k45%2Fdjango-notify-x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fv1k45%2Fdjango-notify-x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fv1k45%2Fdjango-notify-x/lists"}