Skip to content

Commit

Permalink
0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
pandafy authored Sep 2, 2020
1 parent fd30ace commit 3920a51
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 5 deletions.
17 changes: 17 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Changelog
=========

Version 0.1.0 [2020-09-02]
--------------------------

Features
~~~~~~~~

- Added notification types
- Added configurable notification email template
- Added swappable models and extensible classes
- Added REST API for CRUD operations
- Added option to define notification preference
- Added real-time notification alerts
- Added automatic cleanup of old notifications
- Added configurable host for API endpoints.
10 changes: 10 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ OpenWISP Notifications

.. image:: https://travis-ci.org/openwisp/openwisp-notifications.svg?branch=master
:target: https://travis-ci.org/openwisp/openwisp-notifications
:alt: CI build status

.. image:: https://coveralls.io/repos/github/openwisp/openwisp-notifications/badge.svg?branch=master
:target: https://coveralls.io/github/openwisp/openwisp-notifications?branch=master
:alt: Test Coverage

.. image:: https://requires.io/github/openwisp/openwisp-notifications/requirements.svg?branch=master
:target: https://requires.io/github/openwisp/openwisp-notifications/requirements/?branch=master
Expand Down Expand Up @@ -59,6 +61,14 @@ Available features
- `Automatic cleanup of old notifications <#scheduled-deletion-of-notifications>`_
- `Configurable host for API endpoints <#openwisp_notifications_host>`_

Install stable version from pypi
--------------------------------

Install from pypi:

.. code-block:: shell
pip install openwisp-notifications
Install development version
---------------------------

Expand Down
5 changes: 3 additions & 2 deletions openwisp_notifications/tests/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ def test_notification_recipients(self):
joe = self._create_user(username='joe', email='[email protected]')
karen = self._create_user(username='karen', email='[email protected]')
notify.send(sender=self.admin, type='default', recipient=karen)
n = Notification.objects.first()
self.client.force_login(joe)

with self.subTest('Test listing all notifications'):
Expand All @@ -322,7 +323,7 @@ def test_notification_recipients(self):
self.assertEqual(response.status_code, 200)
self.assertIsNone(response.data)
# Check Karen's notification is still unread
n = Notification.objects.first()
n.refresh_from_db()
self.assertTrue(n.unread)

with self.subTest('Test retrieving notification'):
Expand All @@ -337,7 +338,7 @@ def test_notification_recipients(self):
self.assertEqual(response.status_code, 404)
self.assertDictEqual(response.data, {'detail': NOT_FOUND_ERROR})
# Check Karen's notification is still unread
n = Notification.objects.first()
n.refresh_from_db()
self.assertTrue(n.unread)

with self.subTest('Test deleting notification'):
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ def get_install_requires():
version=get_version(),
license='GPL3',
author='Gagan Deep',
author_email='the.one.above.all.titan@gmail.com',
description='OpenWISP 2 Notification Module',
author_email='pandafy.dev@gmail.com',
description='Notifications module of OpenWISP',
long_description=open('README.rst').read(),
url='http://openwisp.org',
download_url='https://github.com/TheOneAboveAllTitan/openwisp-notifications/releases',
download_url='https://github.com/openwisp/openwisp-notifications/releases',
platforms=['Platform Independent'],
keywords=['django', 'netjson', 'notification', 'openwisp', 'monitoring'],
packages=find_packages(exclude=['tests*', 'docs*']),
Expand Down

0 comments on commit 3920a51

Please sign in to comment.