Initial commit: AuroraMusic monorepo
This commit is contained in:
@@ -0,0 +1,177 @@
|
||||
Metadata-Version: 2.1
|
||||
Name: rq
|
||||
Version: 1.16.2
|
||||
Summary: RQ is a simple, lightweight, library for creating background jobs, and processing them.
|
||||
Project-URL: changelog, https://github.com/rq/rq/blob/master/CHANGES.md
|
||||
Project-URL: documentation, https://python-rq.org/docs/
|
||||
Project-URL: homepage, https://python-rq.org/
|
||||
Project-URL: repository, https://github.com/rq/rq/
|
||||
Author-email: Selwin Ong <[email protected]>, Vincent Driessen <[email protected]>
|
||||
Maintainer: Selwin Ong
|
||||
License-Expression: BSD-2-Clause
|
||||
License-File: LICENSE
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: Intended Audience :: End Users/Desktop
|
||||
Classifier: Intended Audience :: Information Technology
|
||||
Classifier: Intended Audience :: Science/Research
|
||||
Classifier: Intended Audience :: System Administrators
|
||||
Classifier: License :: OSI Approved :: BSD License
|
||||
Classifier: Operating System :: MacOS
|
||||
Classifier: Operating System :: POSIX
|
||||
Classifier: Operating System :: Unix
|
||||
Classifier: Programming Language :: Python
|
||||
Classifier: Programming Language :: Python :: 3 :: Only
|
||||
Classifier: Programming Language :: Python :: 3.7
|
||||
Classifier: Programming Language :: Python :: 3.8
|
||||
Classifier: Programming Language :: Python :: 3.9
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Topic :: Internet
|
||||
Classifier: Topic :: Scientific/Engineering
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Classifier: Topic :: System :: Distributed Computing
|
||||
Classifier: Topic :: System :: Monitoring
|
||||
Classifier: Topic :: System :: Systems Administration
|
||||
Requires-Python: >=3.7
|
||||
Requires-Dist: click>=5
|
||||
Requires-Dist: redis>=3.5
|
||||
Description-Content-Type: text/markdown
|
||||
|
||||
RQ (_Redis Queue_) is a simple Python library for queueing jobs and processing
|
||||
them in the background with workers. It is backed by Redis and it is designed
|
||||
to have a low barrier to entry. It should be integrated in your web stack
|
||||
easily.
|
||||
|
||||
RQ requires Redis >= 3.0.0.
|
||||
|
||||
[](https://github.com/rq/rq/actions?query=workflow%3A%22Test+rq%22)
|
||||
[](https://pypi.python.org/pypi/rq)
|
||||
[](https://codecov.io/gh/rq/rq)
|
||||
[](https://github.com/psf/black)
|
||||
|
||||
|
||||
Full documentation can be found [here][d].
|
||||
|
||||
|
||||
## Support RQ
|
||||
|
||||
If you find RQ useful, please consider supporting this project via [Tidelift](https://tidelift.com/subscription/pkg/pypi-rq?utm_source=pypi-rq&utm_medium=referral&utm_campaign=readme).
|
||||
|
||||
|
||||
## Getting started
|
||||
|
||||
First, run a Redis server, of course:
|
||||
|
||||
```console
|
||||
$ redis-server
|
||||
```
|
||||
|
||||
To put jobs on queues, you don't have to do anything special, just define
|
||||
your typically lengthy or blocking function:
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
def count_words_at_url(url):
|
||||
"""Just an example function that's called async."""
|
||||
resp = requests.get(url)
|
||||
return len(resp.text.split())
|
||||
```
|
||||
|
||||
You do use the excellent [requests][r] package, don't you?
|
||||
|
||||
Then, create an RQ queue:
|
||||
|
||||
```python
|
||||
from redis import Redis
|
||||
from rq import Queue
|
||||
|
||||
queue = Queue(connection=Redis())
|
||||
```
|
||||
|
||||
And enqueue the function call:
|
||||
|
||||
```python
|
||||
from my_module import count_words_at_url
|
||||
job = queue.enqueue(count_words_at_url, 'http://nvie.com')
|
||||
```
|
||||
|
||||
Scheduling jobs are also similarly easy:
|
||||
|
||||
```python
|
||||
# Schedule job to run at 9:15, October 10th
|
||||
job = queue.enqueue_at(datetime(2019, 10, 10, 9, 15), say_hello)
|
||||
|
||||
# Schedule job to run in 10 seconds
|
||||
job = queue.enqueue_in(timedelta(seconds=10), say_hello)
|
||||
```
|
||||
|
||||
Retrying failed jobs is also supported:
|
||||
|
||||
```python
|
||||
from rq import Retry
|
||||
|
||||
# Retry up to 3 times, failed job will be requeued immediately
|
||||
queue.enqueue(say_hello, retry=Retry(max=3))
|
||||
|
||||
# Retry up to 3 times, with configurable intervals between retries
|
||||
queue.enqueue(say_hello, retry=Retry(max=3, interval=[10, 30, 60]))
|
||||
```
|
||||
|
||||
For a more complete example, refer to the [docs][d]. But this is the essence.
|
||||
|
||||
|
||||
### The worker
|
||||
|
||||
To start executing enqueued function calls in the background, start a worker
|
||||
from your project's directory:
|
||||
|
||||
```console
|
||||
$ rq worker --with-scheduler
|
||||
*** Listening for work on default
|
||||
Got count_words_at_url('http://nvie.com') from default
|
||||
Job result = 818
|
||||
*** Listening for work on default
|
||||
```
|
||||
|
||||
That's about it.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Simply use the following command to install the latest released version:
|
||||
|
||||
pip install rq
|
||||
|
||||
If you want the cutting edge version (that may well be broken), use this:
|
||||
|
||||
pip install git+https://github.com/rq/rq.git@master#egg=rq
|
||||
|
||||
|
||||
## Related Projects
|
||||
|
||||
Check out these below repos which might be useful in your rq based project.
|
||||
|
||||
- [rq-dashboard](https://github.com/Parallels/rq-dashboard)
|
||||
- [rqmonitor](https://github.com/pranavgupta1234/rqmonitor)
|
||||
- [django-rq](https://github.com/rq/django-rq)
|
||||
- [Flask-RQ2](https://github.com/rq/Flask-RQ2)
|
||||
- [rq-scheduler](https://github.com/rq/rq-scheduler)
|
||||
|
||||
|
||||
## Project history
|
||||
|
||||
This project has been inspired by the good parts of [Celery][1], [Resque][2]
|
||||
and [this snippet][3], and has been created as a lightweight alternative to the
|
||||
heaviness of Celery or other AMQP-based queueing implementations.
|
||||
|
||||
|
||||
[r]: http://python-requests.org
|
||||
[d]: http://python-rq.org/
|
||||
[m]: http://pypi.python.org/pypi/mailer
|
||||
[p]: http://docs.python.org/library/pickle.html
|
||||
[1]: http://docs.celeryq.dev/
|
||||
[2]: https://github.com/resque/resque
|
||||
[3]: https://github.com/fengsp/flask-snippets/blob/1f65833a4291c5b833b195a09c365aa815baea4e/utilities/rq.py
|
||||
Reference in New Issue
Block a user