odoo-addon-cms-info


Nameodoo-addon-cms-info JSON
Version 16.0.1.2.0.4 PyPI version JSON
download
home_pagehttps://github.com/OCA/website-cms
SummaryA set of basic information needed to expose any kind of record in your CMS.
upload_time2024-01-20 07:09:53
maintainer
docs_urlNone
authorCamptocamp, Odoo Community Association (OCA)
requires_python>=3.10
licenseLGPL-3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ========
CMS info
========

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

.. |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-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%2Fwebsite--cms-lightgray.png?logo=github
    :target: https://github.com/OCA/website-cms/tree/16.0/cms_info
    :alt: OCA/website-cms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/website-cms-16-0/website-cms-16-0-cms_info
    :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/website-cms&target_branch=16.0
    :alt: Try me on Runboat

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

Provide basic information for website records / models via `website.published.mixin`.
This module is meant to be used as a base to build your own CMS.

**Table of contents**

.. contents::
   :local:

Usage
=====

New attributes
~~~~~~~~~~~~~~

* ``cms_create_url``: lead to create view. By default ``/cms/create/my.model``
* ``cms_search_url``: lead to search view. By default ``/cms/search/my.model``
* ``cms_edit_url`` (computed field): lead to edit view. By default ``/cms/edit/my.model/model_id``

.. note:: No routing provided.
   This attributes provide only basic information on contents' URLs.
   If you use `cms_form` default routes are handled automatically.
   If not, is up to you to provide your own routes to handle them.


Permission and extra information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* ``record.cms_is_owner()``: current user is the owner of the record?
* ``record.cms_can_edit()``: current user can edit this record?
* ``record.cms_can_publish()``: current user can publish this record?
* ``record.cms_can_delete()``: current user can delete this record?
* ``model.cms_can_create()``: current user can create a new record?


Info all in one
~~~~~~~~~~~~~~~

When you build CMS UIs you need all those info at once.
This module provides also an helper method `cms_info()`
that gives you back a dictionary containing:

* `is_owner`: True/False,
* `can_edit`: True/False,
* `can_create`: True/False,
* `can_publish`: True/False,
* `can_delete`: True/False,
* `create_url`
* `edit_url`
* `delete_url`

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


Get rid of `website` dependency and move `website.published.mixin` integration
to a glue module.

Changelog
=========

16.0.1.0.0 (2023-05-13)
~~~~~~~~~~~~~~~~~~~~~~~

**Features**

- Migration to v16 (`#127 <https://github.com/OCA/website-cms/issues/127>`_)


13.0.1.0.1 (2021-08-23)
~~~~~~~~~~~~~~~~~~~~~~~

**Features**

- Migration to v13 (`#111 <https://github.com/OCA/website-cms/issues/111>`_)


11.0.1.0.1 (2019-01-18)
~~~~~~~~~~~~~~~~~~~~~~~

**Fixes**

- Info dict default to None values
- Test coverage 100%


11.0.1.0.0 (2018-04-27)
~~~~~~~~~~~~~~~~~~~~~~~

**Improvements**

- Initial release

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/website-cms/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/website-cms/issues/new?body=module:%20cms_info%0Aversion:%2016.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>

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/website-cms <https://github.com/OCA/website-cms/tree/16.0/cms_info>`_ 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/website-cms",
    "name": "odoo-addon-cms-info",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "",
    "author": "Camptocamp, Odoo Community Association (OCA)",
    "author_email": "support@odoo-community.org",
    "download_url": "",
    "platform": null,
    "description": "========\nCMS info\n========\n\n.. \n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! This file is generated by oca-gen-addon-readme !!\n   !! changes will be overwritten.                   !!\n   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n   !! source digest: sha256:901af9a4a262f972fa5c079b9a2baffc748fcc335ecd12048815b21536c763a7\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-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%2Fwebsite--cms-lightgray.png?logo=github\n    :target: https://github.com/OCA/website-cms/tree/16.0/cms_info\n    :alt: OCA/website-cms\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n    :target: https://translation.odoo-community.org/projects/website-cms-16-0/website-cms-16-0-cms_info\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/website-cms&target_branch=16.0\n    :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nProvide basic information for website records / models via `website.published.mixin`.\nThis module is meant to be used as a base to build your own CMS.\n\n**Table of contents**\n\n.. contents::\n   :local:\n\nUsage\n=====\n\nNew attributes\n~~~~~~~~~~~~~~\n\n* ``cms_create_url``: lead to create view. By default ``/cms/create/my.model``\n* ``cms_search_url``: lead to search view. By default ``/cms/search/my.model``\n* ``cms_edit_url`` (computed field): lead to edit view. By default ``/cms/edit/my.model/model_id``\n\n.. note:: No routing provided.\n   This attributes provide only basic information on contents' URLs.\n   If you use `cms_form` default routes are handled automatically.\n   If not, is up to you to provide your own routes to handle them.\n\n\nPermission and extra information\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n* ``record.cms_is_owner()``: current user is the owner of the record?\n* ``record.cms_can_edit()``: current user can edit this record?\n* ``record.cms_can_publish()``: current user can publish this record?\n* ``record.cms_can_delete()``: current user can delete this record?\n* ``model.cms_can_create()``: current user can create a new record?\n\n\nInfo all in one\n~~~~~~~~~~~~~~~\n\nWhen you build CMS UIs you need all those info at once.\nThis module provides also an helper method `cms_info()`\nthat gives you back a dictionary containing:\n\n* `is_owner`: True/False,\n* `can_edit`: True/False,\n* `can_create`: True/False,\n* `can_publish`: True/False,\n* `can_delete`: True/False,\n* `create_url`\n* `edit_url`\n* `delete_url`\n\nKnown issues / Roadmap\n======================\n\n\nGet rid of `website` dependency and move `website.published.mixin` integration\nto a glue module.\n\nChangelog\n=========\n\n16.0.1.0.0 (2023-05-13)\n~~~~~~~~~~~~~~~~~~~~~~~\n\n**Features**\n\n- Migration to v16 (`#127 <https://github.com/OCA/website-cms/issues/127>`_)\n\n\n13.0.1.0.1 (2021-08-23)\n~~~~~~~~~~~~~~~~~~~~~~~\n\n**Features**\n\n- Migration to v13 (`#111 <https://github.com/OCA/website-cms/issues/111>`_)\n\n\n11.0.1.0.1 (2019-01-18)\n~~~~~~~~~~~~~~~~~~~~~~~\n\n**Fixes**\n\n- Info dict default to None values\n- Test coverage 100%\n\n\n11.0.1.0.0 (2018-04-27)\n~~~~~~~~~~~~~~~~~~~~~~~\n\n**Improvements**\n\n- Initial release\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/website-cms/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/website-cms/issues/new?body=module:%20cms_info%0Aversion:%2016.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\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/website-cms <https://github.com/OCA/website-cms/tree/16.0/cms_info>`_ 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": "A set of basic information needed to expose any kind of record in your CMS.",
    "version": "16.0.1.2.0.4",
    "project_urls": {
        "Homepage": "https://github.com/OCA/website-cms"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f1f41ad3e97f2780215856fdf4fffb4151eacf9338108ed0a3954467b73bb5cc",
                "md5": "35e73f78d7d48fcd0db700de0082c052",
                "sha256": "dc4997ea9a05d14a6f29db68868f5e8de0c5a4de88e5012e2edb0be6769604bb"
            },
            "downloads": -1,
            "filename": "odoo_addon_cms_info-16.0.1.2.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "35e73f78d7d48fcd0db700de0082c052",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 29228,
            "upload_time": "2024-01-20T07:09:53",
            "upload_time_iso_8601": "2024-01-20T07:09:53.753832Z",
            "url": "https://files.pythonhosted.org/packages/f1/f4/1ad3e97f2780215856fdf4fffb4151eacf9338108ed0a3954467b73bb5cc/odoo_addon_cms_info-16.0.1.2.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-20 07:09:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OCA",
    "github_project": "website-cms",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "odoo-addon-cms-info"
}
        
Elapsed time: 0.72419s