Skip to content

Commit 45c4e39

Browse files
committed
doc:update documentation
1 parent 7b2d14a commit 45c4e39

File tree

7 files changed

+10
-120
lines changed

7 files changed

+10
-120
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ If applicable, add screenshots to help explain your problem.
2727
- OS: [e.g. iOS]
2828
- python version
2929
- django version
30-
- django-rq version
3130
- requirements.txt?
3231

3332
**Additional context**

README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Django RQ Scheduler
1+
Django Tasks Scheduler
22
===================
33
[![Django CI](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml/badge.svg)](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml)
44
![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/cunla/b756396efb895f0e34558c980f1ca0c7/raw/django-tasks-scheduler-4.json)
@@ -7,15 +7,6 @@ Django RQ Scheduler
77

88
Documentation can be found in https://django-tasks-scheduler.readthedocs.io/en/latest/
99

10-
> **Note**: Starting v2023.5.0, django-tasks-scheduler does not require django-rq.
11-
> All required views were migrated. Make sure to read the installation notes in the documentation.
12-
> Particularly how to set up your `urls.py`.
13-
14-
> **Note** Starting v2023.1, requirement for rq_scheduler was removed and instead
15-
> one of the django-rq workers should run with `--with-scheduler` parameter
16-
> as mentioned [here](https://github.com/rq/django-rq#support-for-scheduled-jobs).
17-
18-
1910
# Sponsor
2011

2112
django-tasks-scheduler is developed for free.

docs/changelog.md

Lines changed: 5 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,13 @@
11
# Changelog
22

3-
## v2023.6.1 🌈
3+
## v1.0.0 🌈
44

5-
### 🚀 Features
6-
7-
### 🐛 Bug Fixes
8-
9-
* Minor fix on export model
10-
11-
### 🧰 Maintenance
12-
13-
* Simplified admin + model code significantly
14-
* Remove need for django-model-utils dependency
15-
* Fix GitHub actions
16-
* Fix security issues
17-
* Clean direct redis connection calls from views.py
18-
19-
## v2023.6.0 🌈
20-
21-
### 🚀 Features
22-
23-
* Extend the queue name to 255 characters @gavaig (#138)
24-
25-
### 🧰 Maintenance
26-
27-
* Update dependencies
28-
* Create SECURITY.md @cunla (#125)
29-
30-
## v2023.5.0 🌈
31-
32-
### 🚀 Breaking changes
33-
34-
* Remove django-rq dependency
35-
* Remove threaded scheduler support
36-
37-
### 🚀 Features
38-
39-
* Migrate all required features from django-rq:
40-
* management commands to create worker (rqworker), stats, etc.
41-
* admin view of queues
42-
* admin view for workers.
43-
* admin views are significantly more informative.
44-
* job-ids and worker-ids are more informative.
45-
* Added ability to cancel ongoing job.
46-
* job executions inline in each job.
47-
48-
### 🚀 Roadmap
49-
50-
* Merge all scheduled jobs to one model
51-
52-
## v2023.4.0 🌈
5+
* Migrated from django-rq-scheduler
536

7+
<!--
548
### 🚀 Features
559
56-
* Add management commands to export and import models.
57-
* Add Run Now @gabriels1234 (#106)
58-
59-
### 🧰 Maintenance
60-
61-
* Bump poetry from 1.4.0 to 1.4.1 @dependabot (#107)
62-
* Bump flake8-pyproject from 1.2.2 to 1.2.3 @dependabot (#110)
63-
* Bump fakeredis from 2.10.1 to 2.10.2 @dependabot (#111)
64-
* Bump coverage from 7.2.1 to 7.2.2 @dependabot (#104)
65-
66-
## v2023.3.2 🌈
67-
68-
* Add missing migration
69-
70-
## v2023.3.1 🌈
71-
72-
* Fix: error on django-admin when internal scheduler is off
73-
74-
## v2023.3.0 🌈
75-
7610
### 🐛 Bug Fixes
7711
78-
* fixed validation of callable field @mazhor90 (#93)
79-
80-
## v2023.2.0 🌈
81-
82-
### 🚀 Features
83-
84-
* Start working on documentation on https://django-tasks-scheduler.readthedocs.io/en/latest/
85-
86-
### 🐛 Bug Fixes
87-
88-
* Hotfix new cron @gabriels1234 (#79)
89-
* Make at_front nullable @cunla (#77)
90-
91-
## v2023.3.0 🌈
92-
93-
### 🚀 Breaking changes
94-
95-
* Remove rq-scheduler dependency
96-
97-
### 🚀 Features
98-
99-
* Add support for scheduling at front of the queue #65
12+
### 🧰 Maintenance
13+
-->

docs/index.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Django RQ Scheduler
1+
# Django tasks Scheduler
22

33
[![Django CI](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml/badge.svg)](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml)
44
![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/cunla/b756396efb895f0e34558c980f1ca0c7/raw/django-tasks-scheduler-4.json)
@@ -7,17 +7,9 @@
77

88
---
99

10-
A database backed job scheduler for Django RQ.
10+
A database backed async tasks scheduler for django.
1111
This allows remembering scheduled jobs, their parameters, etc.
1212

13-
!!! Info
14-
15-
Starting v2023.5.0, django-tasks-scheduler does not require django-rq to run.
16-
Most features from django-rq are now implemented on this package.
17-
18-
It is recommended you use the import/export management commands to
19-
save your database.
20-
2113
## Terminology
2214

2315
### Queue
@@ -127,6 +119,4 @@ Please report issues via [GitHub Issues](https://github.com/dsoftwareinc/django-
127119

128120
## Acknowledgements
129121

130-
Based on original [django-tasks-scheduler](https://github.com/isl-x/django-tasks-scheduler) - Now supports Django 4.0.
131-
132122
A lot of django-admin views and their tests were adopted from [django-rq](https://github.com/rq/django-rq).

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ RQ = {
5252
## Scheduling a job Through django-admin
5353

5454
* Sign in to the Django Admin site (e.g., http://localhost:8000/admin/) and locate the
55-
**Django RQ Scheduler** section.
55+
**Tasks Scheduler** section.
5656
* Click on the **Add** link for the type of job you want to add (`Scheduled Job` - run once, `Repeatable Job` - run
5757
multiple times, `Cron Job` - Run based on cron schedule).
5858
* Enter a unique name for the job in the **Name** field.

scheduler/apps.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
class SchedulerConfig(AppConfig):
66
default_auto_field = 'django.db.models.AutoField'
77
name = 'scheduler'
8-
verbose_name = _('Django RQ Scheduler')
8+
verbose_name = _('Tasks Scheduler')
99

1010
def ready(self):
1111
pass

scheduler/tests/test_views.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -456,10 +456,6 @@ def test_worker_details__non_existing_worker(self):
456456
self.assertEqual(404, res.status_code)
457457

458458
def test_statistics_json_view(self):
459-
"""
460-
Django-RQ's statistic as JSON only viewable by staff or with API_TOKEN
461-
"""
462-
463459
# Override testing SCHEDULER_QUEUES
464460
queues = {
465461
'default': {

0 commit comments

Comments
 (0)