Release 0.5.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.0
+current_version = 0.5.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]*)(?P<relver>\d*))?
 serialize =
 	{major}.{minor}.{patch}.{release}{relver}

CONTRIBUTING.rst

@@ -1,17 +1,17 @@
-============
+############
 Contributing
-============
+############
 
 Contributions are welcome, and they are greatly appreciated! Every
 little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
 Types of Contributions
-----------------------
+**********************
 
 Report Bugs
-~~~~~~~~~~~
+===========
 
 Report bugs at https://github.com/nephila/django-knocker/issues.
 
@@ -22,26 +22,26 @@ If you are reporting a bug, please include:
 * Detailed steps to reproduce the bug.
 
 Fix Bugs
-~~~~~~~~
+========
 
 Look through the GitHub issues for bugs. Anything tagged with "bug"
 is open to whoever wants to implement it.
 
 Implement Features
-~~~~~~~~~~~~~~~~~~
+==================
 
 Look through the GitHub issues for features. Anything tagged with "feature"
 is open to whoever wants to implement it.
 
 Write Documentation
-~~~~~~~~~~~~~~~~~~~
+===================
 
 django-knocker could always use more documentation, whether as part of the
 official django-knocker docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
-~~~~~~~~~~~~~~~
+===============
 
 The best way to send feedback is to file an issue at https://github.com/nephila/django-knocker/issues.
 
@@ -52,21 +52,24 @@ If you are proposing a feature:
 * Remember that this is a volunteer-driven project, and that contributions
   are welcome :)
 
+************
 Get Started!
-------------
+************
 
-Ready to contribute? Here's how to set up `django-knocker` for local development.
+Ready to contribute? Here's how to set up ``django-knocker`` for local development.
 
-1. Fork the `django-knocker` repo on GitHub.
+1. Fork the ``django-knocker`` repo on GitHub.
 2. Clone your fork locally::
 
     $ git clone [email protected]:your_name_here/django-knocker.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper
+   installed, this is how you set up your fork for local development::
 
     $ mkvirtualenv django-knocker
     $ cd django-knocker/
-    $ python setup.py develop
+    $ pip install -r requirements-test.txt
+    $ pip install -e .
 
 4. Create a branch for local development::
 
@@ -77,11 +80,9 @@ Now you can make your changes locally.
 5. When you're done making changes, check that your changes pass flake8 and the
 tests, including testing other Python versions with tox::
 
-    $ flake8 knocker tests
-    $ python setup.py test
     $ tox
 
-To get flake8 and tox, just pip install them into your virtualenv.
+To get tox, pip install it into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -91,22 +92,80 @@ To get flake8 and tox, just pip install them into your virtualenv.
 
 7. Submit a pull request through the GitHub website.
 
-Pull Request Guidelines
------------------------
+Development tips
+----------------
 
-Before you submit a pull request, check that it meets these guidelines:
+This project allows you to use `pre-commit <https://pre-commit.com/>`_ to ensure an easy compliance
+to the project code styles.
+
+If you want to use it, install it globally (for example with ``pip3 install --user precommit``,
+but check `installation instruction <https://pre-commit.com/#install>`.
+When first cloning the project ensure you install the git hooks by running ``pre-commit install``.
+
+From now on every commit will be checked against our code style.
+
+Check also the available tox environments with ``tox -l``: the ones not marked with a python version number are tools
+to help you work on the project buy checking / formatting code style, running docs etc.
+
+Testing tips
+----------------
+You can test your project using any specific combination of python, django and django cms.
 
-1. The pull request should include tests.
-2. If the pull request adds functionality, the docs should be updated. Put
-   your new functionality into a function with a docstring, and add the
-   feature to the list in README.rst.
-3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
-   https://travis-ci.org/nephila/django-knocker/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+For example ``tox -epy37-django30-cms37`` runs the tests on python 3.7, Django 3.0 and django CMS 3.7.
 
-Tips
-----
+As the project uses `pytest <https://pytest.org/>`_ as test runner, you can pass any pytest option by setting the
+``PYTEST_ARGS`` environment variable, usually by prepending to the ``tox`` command. Example::
 
-To run a subset of tests::
+    PYTEST_ARGS=" -s  tests/test_plugins.py::PluginTest -p no:warnings" tox -epy37-django30-cms37
+
+
+Pull Request Guidelines
+=======================
+
+Before you submit a pull request, check that it meets these guidelines:
 
-    $ python -m unittest tests.test_knocker
+#. Pull request must be named with the following naming scheme:
+
+   ``<type>/(<optional-task-type>-)<number>-description``
+
+   See below for available types.
+
+#. The pull request should include tests.
+#. If the pull request adds functionality, the docs should be updated.
+   Documentation must be added in ``docs`` directory, and must include usage
+   information for the end user.
+   In case of public API method, add extended docstrings with full parameters
+   description and usage example.
+#. Add a changes file in ``changes`` directory describing the contribution in
+   one line. It will be added automatically to the history file upon release.
+   File must be named as ``<issue-number>.<type>`` with type being:
+
+   * ``.feature``: For new features.
+   * ``.bugfix``: For bug fixes.
+   * ``.doc``: For documentation improvement.
+   * ``.removal``: For deprecation or removal of public API.
+   * ``.misc``: For general issues.
+
+   Check `towncrier`_ documentation for more details.
+
+#. The pull request should work for all python / django / django CMS versions
+   declared in tox.ini.
+   Check the CI and make sure that the tests pass for all supported versions.
+
+Release a version
+=================
+
+#. Update authors file
+#. Merge ``develop`` on ``master`` branch
+#. Bump release via task: ``inv tag-release (major|minor|patch)``
+#. Update changelog via towncrier: ``towncrier --yes``
+#. Commit changelog with ``git commit --amend`` to merge with bumpversion commit
+#. Create tag ``git tag <version>``
+#. Push tag to github
+#. Publish the release from the tags page
+#. If pipeline succeeds, push ``master``
+#. Merge ``master`` back on ``develop``
+#. Bump developement version via task: ``inv tag-dev -l (major|minor|patch)``
+#. Push ``develop``
+
+.. _towncrier: https://pypi.org/project/towncrier/#news-fragments

HISTORY.rst

@@ -1,51 +1,63 @@
 .. :changelog:
 
+***************
 History
--------
+***************
+
+.. towncrier release notes start
+
+0.5.0 (2023-02-19)
+==================
+
+Features
+--------
+
+- Upgrade to Channels 4.0 (#19)
+- Add support for Django 3.2 - 4.1
 
 0.4.0 (2020-05-20)
-++++++++++++++++++
+==================
 
-* Migrated to Channels 2
-* Added support for Django 2.2 / 3.0
-* Dropped support for Python 2
-* Dropped support for Django < 2.2
+- Migrate to Channels 2
+- Add support for Django 2.2 / 3.0
+- Drop support for Python 2
+- Drop support for Django < 2.2
 
 0.3.3 (2018-01-01)
-++++++++++++++++++
+==================
 
-* Fixed support for newer channel versions
-* Fixed error in signal handling
-* Added support for Django 1.11
-* Improved test coverage
+- Fix support for newer channel versions
+- Fix error in signal handling
+- Add support for Django 1.11
+- Improv test coverage
 
 0.3.2 (2016-12-02)
-++++++++++++++++++
+==================
 
-* Add support for Django 1.10
+- Add support for Django 1.10
 
 0.3.1 (2016-09-10)
-++++++++++++++++++
+==================
 
-* Fix error in js message'
+- Fix error in js message'
 
 0.3.0 (2016-08-03)
-++++++++++++++++++
+==================
 
-* Make easier to customize the knocker url
+- Make easier to customize the knocker url
 
 0.2.0 (2016-06-11)
-++++++++++++++++++
+==================
 
-* Fixed documentation
-* Improved routing setting in tests
+- Fix documentation
+- Improv routing setting in tests
 
 0.1.1 (2016-04-08)
-++++++++++++++++++
+==================
 
-* Add Add pause_knocks / active_knocks functions.
+- Add Add pause_knocks / active_knocks functions.
 
 0.1.0 (2016-04-07)
-++++++++++++++++++
+==================
 
-* First release on PyPI.
+- First release on PyPI.

README.rst

@@ -6,26 +6,30 @@ django-knocker
 
 Channels-based desktop notification system
 
+***************
 Documentation
--------------
+***************
 
 The full documentation is at https://django-knocker.readthedocs.io.
 
+***************
 Usage
------
+***************
 
 See https://django-knocker.readthedocs.io/en/latest/usage.html
 
 
+***************
 Features
---------
+***************
 
 * Sends desktop notifications to connected browsers
 * Multilianguage support (with `django-parler`_ and `django-hvad`_)
 * Uses `django-meta`_ API for a consistent metadata handling
 
+***************
 Running Tests
--------------
+***************
 
 Does the code actually work?
 
@@ -35,8 +39,9 @@ Does the code actually work?
     (myenv) $ pip install -r requirements-test.txt
     (myenv) $ python cms_helper.py
 
+***************
 Credits
--------
+***************
 
 Tools used in rendering this package:
 

knocker/__init__.py

@@ -1 +1 @@
-__version__ = "0.4.0"
+__version__ = "0.5.0"

setup.cfg

@@ -18,7 +18,6 @@ classifiers =
 	Framework :: Django :: 3.2
 	Framework :: Django :: 4.0
 	Framework :: Django :: 4.1
-	Framework :: Django :: 4.2
 	Programming Language :: Python
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3.9

tox.ini

@@ -82,20 +82,20 @@ skip_install = true
 commands =
     {envpython} -m invoke clean
     {envpython} -m check_manifest
-    {envpython} -m pep517.build .
+    {envpython} -m build .
     {envpython} -m twine check dist/*
 deps =
     invoke
     check-manifest
-    pep517
+    build
     twine
 skip_install = true
 
 [testenv:release]
 commands =
     {envpython} -m invoke clean
     {envpython} -m check_manifest
-    {envpython} -m pep517.build .
+    {envpython} -m build .
     {envpython} -m twine upload {posargs} dist/*
 deps = {[testenv:pypi-description]deps}
 passenv =