odoo14-addon-jsonifier-stored


Nameodoo14-addon-jsonifier-stored JSON
Version 14.0.1.0.1.dev11 PyPI version JSON
download
home_pagehttps://github.com/OCA/server-tools
SummaryPre-compute and store JSON data on any model
upload_time2024-12-03 03:33:27
maintainerNone
docs_urlNone
authorCamptocamp, Odoo Community Association (OCA)
requires_python>=3.6
licenseAGPL-3
keywords
VCS
bugtrack_url
requirements acme astor cryptography dataclasses dnspython josepy mako odoo_test_helper odoorpc openpyxl openupgradelib pygount pysftp sentry_sdk unidecode
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ==============
JSONify Stored
==============

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

.. |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/14.0/jsonifier_stored
    :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-14-0/server-tools-14-0-jsonifier_stored
    :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/server-tools&target_branch=14.0
    :alt: Try me on Runboat

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

This module provides a mixin to help storing JSON data.

The idea is that you can pre-compute some data
so that the system does not have to compute it
every time it is asked, for instance, by an external service.

Inspired by the machinery in `connector_search_engine`
(which ideally should be refactored on `jsonifier_stored`)
and by a first experiment for v12 done here
https://github.com/OCA/server-tools/pull/1926.

**Table of contents**

.. contents::
   :local:

Usage
=====

This is a technical module,
hence you should take care of extending your models w/ `jsonifier.stored.mixin`.

Your module should also provide a `base_jsonify` compatible exporter
by overriding `_jsonify_get_exporter`.

The cron "JSONify stored - Recompute data for all models"
will recompute data for all inheriting models.

Computations is delegated to queue jobs and by default each job will compute 5 records.
You can tweak this by passing `chunk_size` to `cron_update_json_data_for`.

If your model has a lang field, before jobs are created,
records will be grouped by language.

NOTE: if the model is already existing in your DB is recommended to use
`jsonifier_stored.hooks.add_jsonifier_column` function
to prevent Odoo to compute all data when you update your module.

Known issues / Roadmap
======================

- Make the jsonified_data field recomputed when:
  - any of the exported field is modified
  - the related export is changed (exported fields definition)
- This module is inspired by `connector_search_engine`
  which should be refactored on top of this.

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20jsonifier_stored%0Aversion:%2014.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>
* Matthieu Méquignon <matthieu.mequignon@camptocamp.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.

.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
    :target: https://github.com/simahawk
    :alt: simahawk
.. |maintainer-mmequignon| image:: https://github.com/mmequignon.png?size=40px
    :target: https://github.com/mmequignon
    :alt: mmequignon

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-simahawk| |maintainer-mmequignon| 

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/14.0/jsonifier_stored>`_ 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-tools",
    "name": "odoo14-addon-jsonifier-stored",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Camptocamp, Odoo Community Association (OCA)",
    "author_email": "support@odoo-community.org",
    "download_url": null,
    "platform": null,
    "description": "==============\nJSONify Stored\n==============\n\n.. \n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! This file is generated by oca-gen-addon-readme !!\n   !! changes will be overwritten.                   !!\n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! source digest: sha256:231f0be21732bdbd1416549e1b88519f7498677c21e7fa0954b46b68bf5102e6\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%2Fserver--tools-lightgray.png?logo=github\n    :target: https://github.com/OCA/server-tools/tree/14.0/jsonifier_stored\n    :alt: OCA/server-tools\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n    :target: https://translation.odoo-community.org/projects/server-tools-14-0/server-tools-14-0-jsonifier_stored\n    :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=14.0\n    :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module provides a mixin to help storing JSON data.\n\nThe idea is that you can pre-compute some data\nso that the system does not have to compute it\nevery time it is asked, for instance, by an external service.\n\nInspired by the machinery in `connector_search_engine`\n(which ideally should be refactored on `jsonifier_stored`)\nand by a first experiment for v12 done here\nhttps://github.com/OCA/server-tools/pull/1926.\n\n**Table of contents**\n\n.. contents::\n   :local:\n\nUsage\n=====\n\nThis is a technical module,\nhence you should take care of extending your models w/ `jsonifier.stored.mixin`.\n\nYour module should also provide a `base_jsonify` compatible exporter\nby overriding `_jsonify_get_exporter`.\n\nThe cron \"JSONify stored - Recompute data for all models\"\nwill recompute data for all inheriting models.\n\nComputations is delegated to queue jobs and by default each job will compute 5 records.\nYou can tweak this by passing `chunk_size` to `cron_update_json_data_for`.\n\nIf your model has a lang field, before jobs are created,\nrecords will be grouped by language.\n\nNOTE: if the model is already existing in your DB is recommended to use\n`jsonifier_stored.hooks.add_jsonifier_column` function\nto prevent Odoo to compute all data when you update your module.\n\nKnown issues / Roadmap\n======================\n\n- Make the jsonified_data field recomputed when:\n  - any of the exported field is modified\n  - the related export is changed (exported fields definition)\n- This module is inspired by `connector_search_engine`\n  which should be refactored on top of this.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20jsonifier_stored%0Aversion:%2014.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* Camptocamp\n\nContributors\n~~~~~~~~~~~~\n\n* Simone Orsi <simone.orsi@camptocamp.com>\n* Matthieu M\u00e9quignon <matthieu.mequignon@camptocamp.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\n.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px\n    :target: https://github.com/simahawk\n    :alt: simahawk\n.. |maintainer-mmequignon| image:: https://github.com/mmequignon.png?size=40px\n    :target: https://github.com/mmequignon\n    :alt: mmequignon\n\nCurrent `maintainers <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-simahawk| |maintainer-mmequignon| \n\nThis module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/14.0/jsonifier_stored>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
    "bugtrack_url": null,
    "license": "AGPL-3",
    "summary": "Pre-compute and store JSON data on any model",
    "version": "14.0.1.0.1.dev11",
    "project_urls": {
        "Homepage": "https://github.com/OCA/server-tools"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b4970889a1cb8599209e7c7496d6a2704266c58e230d1ff83da78d918fbac7b1",
                "md5": "02936ce78c192f9c854ea9b37d35ad06",
                "sha256": "8b116bb877014be76e7d5692e6559820be06a940b4d825d76eddbf5588663e56"
            },
            "downloads": -1,
            "filename": "odoo14_addon_jsonifier_stored-14.0.1.0.1.dev11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02936ce78c192f9c854ea9b37d35ad06",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 35746,
            "upload_time": "2024-12-03T03:33:27",
            "upload_time_iso_8601": "2024-12-03T03:33:27.769050Z",
            "url": "https://files.pythonhosted.org/packages/b4/97/0889a1cb8599209e7c7496d6a2704266c58e230d1ff83da78d918fbac7b1/odoo14_addon_jsonifier_stored-14.0.1.0.1.dev11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-03 03:33:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OCA",
    "github_project": "server-tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "acme",
            "specs": []
        },
        {
            "name": "astor",
            "specs": []
        },
        {
            "name": "cryptography",
            "specs": []
        },
        {
            "name": "dataclasses",
            "specs": []
        },
        {
            "name": "dnspython",
            "specs": []
        },
        {
            "name": "josepy",
            "specs": []
        },
        {
            "name": "mako",
            "specs": []
        },
        {
            "name": "odoo_test_helper",
            "specs": []
        },
        {
            "name": "odoorpc",
            "specs": []
        },
        {
            "name": "openpyxl",
            "specs": []
        },
        {
            "name": "openupgradelib",
            "specs": []
        },
        {
            "name": "pygount",
            "specs": []
        },
        {
            "name": "pysftp",
            "specs": []
        },
        {
            "name": "sentry_sdk",
            "specs": [
                [
                    "<=",
                    "1.9.0"
                ]
            ]
        },
        {
            "name": "unidecode",
            "specs": []
        }
    ],
    "lcname": "odoo14-addon-jsonifier-stored"
}
        
Elapsed time: 0.93158s