============
Oneshot cron
============

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! 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%2Fserver--tools-lightgray.png?logo=github
    :target: https://github.com/OCA/server-tools/tree/11.0/base_cron_oneshot
    :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_cron_oneshot
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
    :target: https://runbot.odoo-community.org/runbot/149/11.0
    :alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5| 

This module extends the functionality of Odoo crons
to allow you to create single-purpose crons without any further setup or modules
such as `queue_job`.

The typical use case is: you have an expensive task to run on demand and only once.

A main cron called "Oneshot cron cleanup" will delete already executed crons each day.
You might want to tune it according to your needs.

**Table of contents**

.. contents::
   :local:

Usage
=====

You can create crons as usual via the admin interface or via code.
The important thing, in both case, is to set `oneshot` flag as true.

**Developer shortcut**

You can easily create a oneshot cron like this:

.. code-block:: python

  cron = self.env['ir.cron'].schedule_oneshot(
      'res.partner', method='my_cron_method')

If you need to customize other parameters you can pass them as keyword args:

.. code-block:: python

  my_values = {...}
  cron = self.env['ir.cron'].schedule_oneshot(
      'res.partner', method='my_cron_method', **my_values)

Changelog
=========

11.0.1.0.0 (2018-08-30)
~~~~~~~~~~~~~~~~~~~~~~~

* First release

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20base_cron_oneshot%0Aversion:%2011.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
~~~~~~~

* Camptocamp

Contributors
~~~~~~~~~~~~

* Simone Orsi <simone.orsi@camptocamp.com>
* Artem Kostyuk <a.kostyuk@mobilunity.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/server-tools <https://github.com/OCA/server-tools/tree/11.0/base_cron_oneshot>`_ project on GitHub.

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