Metadata-Version: 2.1
Name: odoo-addon-queue_job_batch
Version: 18.0.1.1.0
Requires-Python: >=3.10
Requires-Dist: odoo-addon-queue_job==18.0.*
Requires-Dist: odoo==18.0.*
Summary: Job Queue Batch
Home-page: https://github.com/OCA/queue
License: AGPL-3
Author: Creu Blanca,Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

===============
Job Queue Batch
===============

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:81d1edb81bb2c114b7afe11730c4f36f6eedcf5fe32a6b258600fd24d69a4be9
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-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/18.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-18-0/queue-18-0-queue_job_batch
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/queue&target_branch=18.0
    :alt: Try me on Runboat

|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:: python

   from odoo import models, fields, api


   class MyModel(models.Model):
       _name = 'my.model'

       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')
           model = self.env['my.model'].with_context(job_batch=batch)
           for i in range(1, 100):
               model.with_delay().my_method('a', k=i)

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/queue/issues/new?body=module:%20queue_job_batch%0Aversion:%2018.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>

- `Trobz <https://trobz.com>`__:

  - Hoang Diep <hoang@trobz.com>

- `ForgeFlow <https://forgeflow.com>`__:

  - Lois Rilo <lois.rilo@forgeflow.com>
  - Jasmin Solanki <jasmin.solanki@forgeflow.com>

- `Camptocamp <https://camptocamp.com>`__:

  - Maksym Yankin <maksym.yankin@camptocamp.com>
  - Iván Todorovich <ivan.todorovich@camptocamp.com>

Other credits
-------------

The migration of this module from 12.0 to 14.0 was financially supported
by Camptocamp

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/18.0/queue_job_batch>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
