==========
Date Range
==========
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png
:target: https://odoo-community.org/page/development-status
:alt: Mature
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github
:target: https://github.com/OCA/server-ux/tree/12.0/date_range
:alt: OCA/server-ux
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-ux-12-0/server-ux-12-0-date_range
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/250/12.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This module lets you define global date ranges that can be used to filter
your values in tree views.
It also provides a mixin model for developers that extends the model's search
view so that date ranges can be search as any relational field.
**Table of contents**
.. contents::
:local:
Installation
============
The addon use the daterange method from postgres. This method is supported as of postgresql 9.2
Configuration
=============
For regular usage, see `Usage` below. This section is to clarify optional
functionality to developers.
To configure a model to use the Many2one style search field, make the model
inherit from `date.range.search.mixin`:
.. code-block::
class AccountMove(models.Model):
_name = "account.move"
_inherit = ["account.move", "date.range.search.mixin"]
This will make a `Period` field show up in the search view:
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/12.0/date_range/static/description/date_range_many2one_search_field.png
:scale: 80 %
:alt: Date range Many2one search field
By default, the mixin works on the `date` field. If you want the mixin to work
on a field with a different name, you can set a property on your model:
.. code-block::
_date_range_search_field = "invoice_date"
Usage
=====
To configure this module, you need to:
* Go to Settings > Technical > Date ranges > Date Range Types where
you can create types of date ranges.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_create.png
:scale: 80 %
:alt: Create a type of date range
* Go to Settings > Technical > Date ranges > Date Ranges where
you can create date ranges.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_create.png
:scale: 80 %
:alt: Date range creation
It's also possible to launch a wizard from the 'Generate Date Ranges' menu.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard.png
:scale: 80 %
:alt: Date range wizard
The wizard is useful to generate recurring periods.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard_result.png
:scale: 80 %
:alt: Date range wizard result
* Your date ranges are now available in the search filter for any date or datetime fields
Date range types are proposed as a filter operator
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_as_filter.png
:scale: 80 %
:alt: Date range type available as filter operator
Once a type is selected, date ranges of this type are porposed as a filter value
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter.png
:scale: 80 %
:alt: Date range as filter value
And the dates specified into the date range are used to filter your result.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter_result.png
:scale: 80 %
:alt: Date range as filter result
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/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-ux/issues/new?body=module:%20date_range%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
~~~~~~~
* ACSONE SA/NV
Contributors
~~~~~~~~~~~~
* Laurent Mignon <laurent.mignon@acsone.eu>
* Alexis de Lattre <alexis.delattre@akretion.com>
* Miquel Raïch <miquel.raich@eficent.com>
* Andrea Stirpe <a.stirpe@onestein.nl>
* Stefan Rijnhart <stefan@opener.amsterdam>
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.
.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px
:target: https://github.com/lmignon
:alt: lmignon
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-lmignon|
This module is part of the `OCA/server-ux <https://github.com/OCA/server-ux/tree/12.0/date_range>`_ 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/server-ux",
"name": "odoo12-addon-date-range",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "",
"author": "ACSONE SA/NV, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": "==========\nDate Range\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-Mature-brightgreen.png\n :target: https://odoo-community.org/page/development-status\n :alt: Mature\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github\n :target: https://github.com/OCA/server-ux/tree/12.0/date_range\n :alt: OCA/server-ux\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-ux-12-0/server-ux-12-0-date_range\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/250/12.0\n :alt: Try me on Runbot\n\n|badge1| |badge2| |badge3| |badge4| |badge5| \n\nThis module lets you define global date ranges that can be used to filter\nyour values in tree views.\n\nIt also provides a mixin model for developers that extends the model's search\nview so that date ranges can be search as any relational field.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nInstallation\n============\n\nThe addon use the daterange method from postgres. This method is supported as of postgresql 9.2\n\nConfiguration\n=============\n\nFor regular usage, see `Usage` below. This section is to clarify optional\nfunctionality to developers.\n\nTo configure a model to use the Many2one style search field, make the model\ninherit from `date.range.search.mixin`:\n\n.. code-block::\n\n class AccountMove(models.Model):\n _name = \"account.move\"\n _inherit = [\"account.move\", \"date.range.search.mixin\"]\n\nThis will make a `Period` field show up in the search view:\n\n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/12.0/date_range/static/description/date_range_many2one_search_field.png\n :scale: 80 %\n :alt: Date range Many2one search field\n\nBy default, the mixin works on the `date` field. If you want the mixin to work\non a field with a different name, you can set a property on your model:\n\n.. code-block::\n\n _date_range_search_field = \"invoice_date\"\n\nUsage\n=====\n\nTo configure this module, you need to:\n\n* Go to Settings > Technical > Date ranges > Date Range Types where\n you can create types of date ranges.\n\n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_create.png\n :scale: 80 %\n :alt: Create a type of date range\n\n* Go to Settings > Technical > Date ranges > Date Ranges where\n you can create date ranges.\n \n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_create.png\n :scale: 80 %\n :alt: Date range creation\n \n It's also possible to launch a wizard from the 'Generate Date Ranges' menu.\n\n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard.png\n :scale: 80 %\n :alt: Date range wizard\n\n The wizard is useful to generate recurring periods.\n \n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard_result.png\n :scale: 80 %\n :alt: Date range wizard result\n\n* Your date ranges are now available in the search filter for any date or datetime fields\n\n Date range types are proposed as a filter operator\n \n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_as_filter.png\n :scale: 80 %\n :alt: Date range type available as filter operator\n\n Once a type is selected, date ranges of this type are porposed as a filter value\n\n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter.png\n :scale: 80 %\n :alt: Date range as filter value\n\n And the dates specified into the date range are used to filter your result.\n \n .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter_result.png\n :scale: 80 %\n :alt: Date range as filter result\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/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/server-ux/issues/new?body=module:%20date_range%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* ACSONE SA/NV\n\nContributors\n~~~~~~~~~~~~\n\n* Laurent Mignon <laurent.mignon@acsone.eu>\n* Alexis de Lattre <alexis.delattre@akretion.com>\n* Miquel Ra\u00efch <miquel.raich@eficent.com>\n* Andrea Stirpe <a.stirpe@onestein.nl>\n* Stefan Rijnhart <stefan@opener.amsterdam>\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\n.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px\n :target: https://github.com/lmignon\n :alt: lmignon\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-lmignon| \n\nThis module is part of the `OCA/server-ux <https://github.com/OCA/server-ux/tree/12.0/date_range>`_ 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": "LGPL-3",
"summary": "Manage all kind of date range",
"version": "12.0.2.1.0",
"project_urls": {
"Homepage": "https://github.com/OCA/server-ux"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "866993c3bef810a14f6325feb97cceaecd8a98065e341a80512e40bb2583f410",
"md5": "c66521857ab8c153a3194e5aced3c7c8",
"sha256": "85654d719175e3f5ad2839210c25b20d249f3f16f31730076aa4998347d65147"
},
"downloads": -1,
"filename": "odoo12_addon_date_range-12.0.2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c66521857ab8c153a3194e5aced3c7c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 1035717,
"upload_time": "2023-05-22T11:24:04",
"upload_time_iso_8601": "2023-05-22T11:24:04.925972Z",
"url": "https://files.pythonhosted.org/packages/86/69/93c3bef810a14f6325feb97cceaecd8a98065e341a80512e40bb2583f410/odoo12_addon_date_range-12.0.2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-22 11:24:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "server-ux",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo12-addon-date-range"
}