From 0ddef44400e7a54e2219c9574e7cf81718753139 Mon Sep 17 00:00:00 2001 From: Stan Triepels <1939656+GDay@users.noreply.github.com> Date: Fri, 21 Oct 2022 00:04:58 +0200 Subject: [PATCH] Bump version and docs fixes (#21) --- README.rst | 6 +++++- docs/admin.rst | 4 ++-- docs/conf.py | 4 ++-- docs/configure.rst | 2 +- docs/index.rst | 2 +- docs/install.rst | 8 ++++---- docs/monitor.rst | 2 +- pyproject.toml | 2 +- 8 files changed, 17 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index d726054..0bd8215 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,6 @@ Requirements - `Django `__ > = 3.2 - `Django-picklefield `__ -- `Blessed `__ Tested with: Python 3.7, 3.8, 3.9, 3.10 Django 3.2.X and 4.1.X @@ -93,6 +92,11 @@ For full configuration options, see the `configuration documentation + + Start a cluster with:: $ python manage.py qcluster diff --git a/docs/admin.rst b/docs/admin.rst index a774c4c..d51fe72 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -4,8 +4,8 @@ Admin pages =========== -Django Q does not use custom pages, but instead leverages what is offered by Django's model admin by default. -When you open Django Q's admin pages you will see three models: +Django Q2 does not use custom pages, but instead leverages what is offered by Django's model admin by default. +When you open Django Q2's admin pages you will see three models: Successful tasks ---------------- diff --git a/docs/conf.py b/docs/conf.py index 353b8d5..469ac4a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,9 +71,9 @@ author = 'Ilan Steemers, Stan Triepels' # built documents. # # The short X.Y version. -version = '1.3' +version = '1.4' # The full version, including alpha/beta/rc tags. -release = '1.4.0' +release = '1.4.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/configure.rst b/docs/configure.rst index 01241f3..32d6f11 100644 --- a/docs/configure.rst +++ b/docs/configure.rst @@ -143,7 +143,7 @@ Limits the amount of successful tasks saved to Django. - Failures are always saved. save_limit_per -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~ The above ``save_limit`` for successful tasks can be fine tuned per task type using - Set to ``"group"`` to store the tasks per group diff --git a/docs/index.rst b/docs/index.rst index 02628be..d5a2dea 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,7 +27,7 @@ Features - Rollbar and Sentry support -Django Q is tested with: Python 3.7, 3.8, 3.9 and 3.10, Django 2.2.x and 3.2.x +Django Q2 is tested with: Python 3.7, 3.8, 3.9 and 3.10, Django 2.2.x and 3.2.x Currently available in English, German and French. diff --git a/docs/install.rst b/docs/install.rst index 2a110d5..3e72ffe 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -38,13 +38,13 @@ Django Q2 is tested for Python 3.7, 3.8, 3.9 and 3.10 Used to store args, kwargs and result objects in the database. -- `Blessed `__ - - This feature-filled fork of Erik Rose's blessings project provides the terminal layout of the monitor. - Optional ~~~~~~~~ +- `Blessed `__ is used to display the statistics in the terminal:: + + $ pip install blessed + - `Redis-py `__ client by Andy McCurdy is used to interface with both the Redis:: $ pip install redis diff --git a/docs/monitor.rst b/docs/monitor.rst index a5be095..d142195 100644 --- a/docs/monitor.rst +++ b/docs/monitor.rst @@ -4,9 +4,9 @@ Monitor .. warning:: - Blessed needs to be installed to get this to work! See: https://pypi.org/project/blessed/ + The cluster monitor shows live information about all the Q clusters connected to your project. Start the monitor with Django's `manage.py` command:: diff --git a/pyproject.toml b/pyproject.toml index 2e0d414..06e3e8b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "django-q2" -version = "1.4.0" +version = "1.4.1" packages = [ { include = "django_q" }, ]