Merge pull request #26 from boxine/prepare-release

Update README and release as v0.4.0
boxine · May 21, 2021 · 41fa9f1 · 41fa9f1
2 parents 7954876 + 0220913
commit 41fa9f1
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ pip install django-huey-monitor
 ```python
 INSTALLED_APPS = [
     #...
-    'bx_py_utils', # https://github.com/boxine/bx_py_utils
+    'bx_django_utils', # https://github.com/boxine/bx_django_utils
     'huey_monitor',
     #...
 ]
@@ -153,10 +153,29 @@ without docker:
 ~/django-huey-monitor$ ./manage.sh run_testserver
 ```
 
+## Backwards-incompatible changes
+
+### v0.3.0 -> v0.4.0 - Outsourcing Django stuff
+
+[bx_py_utils](https://github.com/boxine/bx_py_utils) was split and Django related stuff moved into: [bx_django_utils](https://github.com/boxine/bx_django_utils)
+
+You must change your Django settings and replace the app name:
+```diff
+ INSTALLED_APPS = [
+     #...
+-     'bx_py_utils',
++     'bx_django_utils',
+     'huey_monitor',
+     #...
+ ]
+```
+
 ## History
 
-* [dev](https://github.com/boxine/django-huey-monitor/compare/v0.3.0...master)
+* [dev](https://github.com/boxine/django-huey-monitor/compare/v0.4.0...master)
   * _tbc_
+* [v0.4.0 - 21.05.2020](https://github.com/boxine/django-huey-monitor/compare/v0.3.0...v0.4.0)
+  * bx_py_utils was split and Django related stuff moved into: https://github.com/boxine/bx_django_utils
 * [v0.3.0 - 22.02.2020](https://github.com/boxine/django-huey-monitor/compare/v0.2.0...v0.3.0)
   * Store and display running task progress information a little bit as [tqdm](https://pypi.org/project/tqdm/) [#17](https://github.com/boxine/django-huey-monitor/issues/17)
 * [v0.2.0 - 17.02.2020](https://github.com/boxine/django-huey-monitor/compare/v0.1.0...v0.2.0)

diff --git a/huey_monitor/__init__.py b/huey_monitor/__init__.py
@@ -2,4 +2,4 @@
     Huey Monitor Django reuseable App
 """
 default_app_config = 'huey_monitor.apps.HueyMonitorConfig'
-__version__ = '0.4.0-rc.1'
+__version__ = '0.4.0'
diff --git a/huey_monitor/checks.py b/huey_monitor/checks.py
@@ -7,7 +7,7 @@ def huey_monitor_check(app_configs, **kwargs):
     errors = []
 
     if 'bx_django_utils' not in settings.INSTALLED_APPS:
-        # bx_py_utils is needed for "humanize_time" template library
+        # bx_django_utils is needed for "humanize_time" template library
         # See: https://github.com/boxine/django-huey-monitor/issues/21
         errors.append(
             Warning(

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-huey-monitor"
-version = "0.4.0-rc.1"
+version = "0.4.0"
 description = "Django based tool for monitoring huey task queue: https://github.com/coleifer/huey"
 authors = ["JensDiemer <[email protected]>"]
 packages = [