===============
Job Queue Batch
===============
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github
:target: https://github.com/OCA/queue/tree/12.0/queue_job_batch
:alt: OCA/queue
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/queue-12-0/queue-12-0-queue_job_batch
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/230/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This addon adds an a grouper for queue jobs.
It allows to show your jobs in a batched form in order to know better the
results.
Example:
.. code-block:: python
from odoo import models, fields, api
from odoo.addons.queue_job.job import job
class MyModel(models.Model):
_name = 'my.model'
@api.multi
@job
def my_method(self, a, k=None):
_logger.info('executed with a: %s and k: %s', a, k)
class MyOtherModel(models.Model):
_name = 'my.other.model'
@api.multi
def button_do_stuff(self):
batch = self.env['queue.job.batch'].get_new_batch('Group')
for i in range(1, 100):
self.env['my.model'].with_context(
job_batch=batch
).with_delay().my_method('a', k=i)
batch.enqueue()
In the snippet of code above, when we call ``button_do_stuff``, 100 jobs
capturing the method and arguments will be postponed. It will be executed as
soon as the Jobrunner has a free bucket, which can be instantaneous if no other
job is running.
Once all the jobs have finished, the grouper will be marked as finished.
**Table of contents**
.. contents::
:local:
Usage
=====
You can manage your batch jobs from the Systray. A new button will be shown
with your currently executing job batches and the recently finished job groups.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job_batch%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* Creu Blanca
Contributors
~~~~~~~~~~~~
* Enric Tobella <etobella@creublanca.es>
* Lois Rilo <lois.rilo@eficent.com>
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
This module is part of the `OCA/queue <https://github.com/OCA/queue/tree/12.0/queue_job_batch>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/queue",
"name": "odoo12-addon-queue-job-batch",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "",
"author": "Creu Blanca,Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": "",
"description": "===============\nJob Queue Batch\n===============\n\n.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fqueue-lightgray.png?logo=github\n :target: https://github.com/OCA/queue/tree/12.0/queue_job_batch\n :alt: OCA/queue\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/queue-12-0/queue-12-0-queue_job_batch\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png\n :target: https://runbot.odoo-community.org/runbot/230/12.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nThis addon adds an a grouper for queue jobs.\n\nIt allows to show your jobs in a batched form in order to know better the\nresults.\n\nExample:\n\n.. code-block:: python\n\n from odoo import models, fields, api\n from odoo.addons.queue_job.job import job\n\n class MyModel(models.Model):\n _name = 'my.model'\n\n @api.multi\n @job\n def my_method(self, a, k=None):\n _logger.info('executed with a: %s and k: %s', a, k)\n\n\n class MyOtherModel(models.Model):\n _name = 'my.other.model'\n\n @api.multi\n def button_do_stuff(self):\n batch = self.env['queue.job.batch'].get_new_batch('Group')\n for i in range(1, 100):\n self.env['my.model'].with_context(\n job_batch=batch\n ).with_delay().my_method('a', k=i)\n batch.enqueue()\n\n\nIn the snippet of code above, when we call ``button_do_stuff``, 100 jobs\ncapturing the method and arguments will be postponed. It will be executed as\nsoon as the Jobrunner has a free bucket, which can be instantaneous if no other\njob is running.\n\nOnce all the jobs have finished, the grouper will be marked as finished.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nYou can manage your batch jobs from the Systray. A new button will be shown\nwith your currently executing job batches and the recently finished job groups.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/queue/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us smashing it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job_batch%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Creu Blanca\n\nContributors\n~~~~~~~~~~~~\n\n* Enric Tobella <etobella@creublanca.es>\n* Lois Rilo <lois.rilo@eficent.com>\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/queue <https://github.com/OCA/queue/tree/12.0/queue_job_batch>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Job Queue Batch",
"version": "12.0.1.0.1",
"project_urls": {
"Homepage": "https://github.com/OCA/queue"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6a99467927440c463c8e7a8790cd607c8dc40efae64017252ef62ebd09d90f57",
"md5": "2e74b4d95dadb727b695d77a85397184",
"sha256": "86a8272508a82f709fb410b4d249a0f65ad5cf7de1db09534dbaa7c2d819a847"
},
"downloads": -1,
"filename": "odoo12_addon_queue_job_batch-12.0.1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e74b4d95dadb727b695d77a85397184",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 26006,
"upload_time": "2020-02-04T05:54:45",
"upload_time_iso_8601": "2020-02-04T05:54:45.756239Z",
"url": "https://files.pythonhosted.org/packages/6a/99/467927440c463c8e7a8790cd607c8dc40efae64017252ef62ebd09d90f57/odoo12_addon_queue_job_batch-12.0.1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-02-04 05:54:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "queue",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo12-addon-queue-job-batch"
}
JSON
