rq
=============================================================
Cube for starting RqJobs on a Rq worker
Installation
------------
Open the project in a terminal and run::
pip install -e .
This will install the cube in your active virtual environment
as ``cubicweb-rq``.
The following sections indicate additional steps when you
install this cube as a dependency or as an instance.
As a dependency
~~~~~~~~~~~~~~~
If you plan to use this cube as a dependency for your own cube,
add it to your ``__pkginfo__.py`` as follows::
__depends__ = {
# ... Your previous dependencies
"cubicweb-rq": None,
}
If the target cube is already used as an instance, you need to migrate it
with the help of its python shell (replace ``YOUR_INSTANCE_NAME`` by your instance name)::
cubicweb-ctl shell YOUR_INSTANCE_NAME
In the python prompt, enter the following command::
add_cube("rq")
Press ``Ctrl-D`` then restart your instance.
The cube should now be available in your instance.
As an instance
~~~~~~~~~~~~~~
If you plan to use this cube directly as an instance, create and start
your instance with the following commands (replace ``cubicweb-instance``
by the name of your choice)::
cubicweb-ctl create rq cubicweb-instance
cubicweb-ctl start -D cubicweb-instance
Learn More
----------
Visit the `official documentation <https://cubicweb.readthedocs.io/en/4.5.2>`_
to learn more about CubicWeb.
Launch a worker
---------------
Have redis installed and running on your machine.
::
$ sudo apt-get install redis-server
$ sudo system-ctl start redis
In your `~/etc/cubicweb.d/cubicweb-instance/pyramid.ini` file,
add the following lines
::
redis.sessions.timeout = 1200
redis.sessions.secret = stuff
redis.sessions.prefix = cubicweb-instance:
redis.sessions.url = redis://localhost:6379/0
rq.redis_url = redis://localhost:6379/0
Launch a worker with the following command line (replace ``cubicweb-instance``
with the name of your cubicweb instance)::
cubicweb-ctl rq-worker cubicweb-instance
Raw data
{
"_id": null,
"home_page": "https://forge.extranet.logilab.fr/cubicweb/cubes/rq",
"name": "cubicweb-rq",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "LOGILAB S.A. (Paris, FRANCE)",
"author_email": "contact@logilab.fr",
"download_url": "https://files.pythonhosted.org/packages/86/1c/f5fe2032c760ac903b4f5b575bdf37cd762a7d6feb9620d61637341927ad/cubicweb-rq-0.1.1.tar.gz",
"platform": null,
"description": "rq\n=============================================================\n\nCube for starting RqJobs on a Rq worker\n\nInstallation\n------------\n\nOpen the project in a terminal and run::\n\n pip install -e .\n\nThis will install the cube in your active virtual environment\nas ``cubicweb-rq``.\n\nThe following sections indicate additional steps when you\ninstall this cube as a dependency or as an instance.\n\nAs a dependency\n~~~~~~~~~~~~~~~\n\nIf you plan to use this cube as a dependency for your own cube,\nadd it to your ``__pkginfo__.py`` as follows::\n\n __depends__ = {\n # ... Your previous dependencies\n \"cubicweb-rq\": None,\n }\n\nIf the target cube is already used as an instance, you need to migrate it\nwith the help of its python shell (replace ``YOUR_INSTANCE_NAME`` by your instance name)::\n\n cubicweb-ctl shell YOUR_INSTANCE_NAME\n\nIn the python prompt, enter the following command::\n\n add_cube(\"rq\")\n\nPress ``Ctrl-D`` then restart your instance.\nThe cube should now be available in your instance.\n\nAs an instance\n~~~~~~~~~~~~~~\n\nIf you plan to use this cube directly as an instance, create and start\nyour instance with the following commands (replace ``cubicweb-instance``\nby the name of your choice)::\n\n cubicweb-ctl create rq cubicweb-instance\n cubicweb-ctl start -D cubicweb-instance\n\n\nLearn More\n----------\n\nVisit the `official documentation <https://cubicweb.readthedocs.io/en/4.5.2>`_\nto learn more about CubicWeb.\n\n\n\nLaunch a worker\n---------------\n\nHave redis installed and running on your machine.\n\n::\n\n $ sudo apt-get install redis-server\n $ sudo system-ctl start redis\n\nIn your `~/etc/cubicweb.d/cubicweb-instance/pyramid.ini` file,\nadd the following lines\n\n::\n\n redis.sessions.timeout = 1200\n redis.sessions.secret = stuff\n redis.sessions.prefix = cubicweb-instance:\n redis.sessions.url = redis://localhost:6379/0\n rq.redis_url = redis://localhost:6379/0\n\n\nLaunch a worker with the following command line (replace ``cubicweb-instance``\nwith the name of your cubicweb instance)::\n\n cubicweb-ctl rq-worker cubicweb-instance\n\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "Cube for starting RqJobs on a Rq worker",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/rq"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2a3643177a299133b471fa2334bd5bbb1b75a61eb53da3b3f32ad7c9c742985c",
"md5": "112e107c671b121b4e60d9dc338dd830",
"sha256": "56f9fcaa90fe3df87ceff7c810927bb0caa8575e969979ded0cb0044661bbeaf"
},
"downloads": -1,
"filename": "cubicweb_rq-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "112e107c671b121b4e60d9dc338dd830",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12358,
"upload_time": "2024-04-04T08:40:08",
"upload_time_iso_8601": "2024-04-04T08:40:08.426962Z",
"url": "https://files.pythonhosted.org/packages/2a/36/43177a299133b471fa2334bd5bbb1b75a61eb53da3b3f32ad7c9c742985c/cubicweb_rq-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "861cf5fe2032c760ac903b4f5b575bdf37cd762a7d6feb9620d61637341927ad",
"md5": "e826f8b397ffffb26ca424a3218d5e63",
"sha256": "89395a01916bf7129c5650ba421181e0351f8a954ebf7af6c24f04795633a72e"
},
"downloads": -1,
"filename": "cubicweb-rq-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "e826f8b397ffffb26ca424a3218d5e63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10366,
"upload_time": "2024-04-04T08:40:10",
"upload_time_iso_8601": "2024-04-04T08:40:10.332710Z",
"url": "https://files.pythonhosted.org/packages/86/1c/f5fe2032c760ac903b4f5b575bdf37cd762a7d6feb9620d61637341927ad/cubicweb-rq-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 08:40:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cubicweb-rq"
}
JSON