cubicweb-tag


Namecubicweb-tag JSON
Version 3.1.1 PyPI version JSON
download
home_pagehttps://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-tag
Summarytag component for the CubicWeb framework
upload_time2025-07-09 14:50:37
maintainerNone
docs_urlNone
authorLogilab
requires_python>=3.9.2
licenseLGPL
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Summary
-------

The tag cube allows to add labels to an entity as a simple yet
powerful way to classify your content. Tags can be used to refine a
search using facets.

It is a CubicWeb component. CubicWeb is a semantic web application
framework, see http://www.cubicweb.org

Install
-------

Auto-install from sources is preferred with *pip/Distribute*::

  pip install cubicweb-tag

If you have troubles, use *easy_install/setuptools* and eggs::

  easy_install cubicweb-tag

You can install the package manually from the uncompressed
`tarball <http://www.cubicweb.org/project/cubicweb-tag>`_::

  python setup.py install # auto-install dependencies

If you don't want the dependencies to be installed automatically, you
can force the setup to use the standard library *distutils*::

  NO_SETUPTOOLS=1 python setup.py install

More details at http://www.cubicweb.org/doc/en/admin/setup

Usage
-----

To allow tags on an entity type, you must allow the `tags` relation between `Tag`
and your entity type(s).

For instance to activate the tag functionality on Person, Company and Division
entity type, one should add to his schema:

.. sourcecode:: python

   from yams.buildobjs import RelationDefinition
   class tags(RelationDefinition):
       subject = 'Tag'
       object = ('Person', 'Company', 'Division')

You should then see the tags box appearing on the primary view for entities of
those type. The`TagsBox` display tags applied to the entity but also provides
an easily way to add / remove tags, if you've the permission to do so.

More views
----------
- The `SimilarEntitiesBox` shows some entities which share the most tags together

- The `TagsCloudView`, a classical, displaying a set of tags appearing more or
  less big according to the number of tagged entities. It's used by the
  `TagsCouldBox`, which is not visible by default (user can activate it using
  their preferences)  but that you can activate by default using the code snippet below:

  .. sourcecode:: python

    from cubicweb_tag.views import TagsCloudBox
    # make the tags cloud box visible by default
    TagsCloudBox.visible = True

- The primary view for tags provides a tags merging interface to site administrators,
  very useful to manage tags on a site where people tend to express the same thing with
  different words, or spelling.

Documentation
-------------

Look in the ``doc/`` subdirectory or read
http://www.cubicweb.org/doc/en/

            

Raw data

            {
    "_id": null,
    "home_page": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-tag",
    "name": "cubicweb-tag",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9.2",
    "maintainer_email": null,
    "keywords": null,
    "author": "Logilab",
    "author_email": "contact@logilab.fr",
    "download_url": "https://files.pythonhosted.org/packages/07/f7/4a57a7d742887c9e271d7c51ae169421e698301274b3c4d8537cb2a53a6f/cubicweb_tag-3.1.1.tar.gz",
    "platform": null,
    "description": "Summary\n-------\n\nThe tag cube allows to add labels to an entity as a simple yet\npowerful way to classify your content. Tags can be used to refine a\nsearch using facets.\n\nIt is a CubicWeb component. CubicWeb is a semantic web application\nframework, see http://www.cubicweb.org\n\nInstall\n-------\n\nAuto-install from sources is preferred with *pip/Distribute*::\n\n  pip install cubicweb-tag\n\nIf you have troubles, use *easy_install/setuptools* and eggs::\n\n  easy_install cubicweb-tag\n\nYou can install the package manually from the uncompressed\n`tarball <http://www.cubicweb.org/project/cubicweb-tag>`_::\n\n  python setup.py install # auto-install dependencies\n\nIf you don't want the dependencies to be installed automatically, you\ncan force the setup to use the standard library *distutils*::\n\n  NO_SETUPTOOLS=1 python setup.py install\n\nMore details at http://www.cubicweb.org/doc/en/admin/setup\n\nUsage\n-----\n\nTo allow tags on an entity type, you must allow the `tags` relation between `Tag`\nand your entity type(s).\n\nFor instance to activate the tag functionality on Person, Company and Division\nentity type, one should add to his schema:\n\n.. sourcecode:: python\n\n   from yams.buildobjs import RelationDefinition\n   class tags(RelationDefinition):\n       subject = 'Tag'\n       object = ('Person', 'Company', 'Division')\n\nYou should then see the tags box appearing on the primary view for entities of\nthose type. The`TagsBox` display tags applied to the entity but also provides\nan easily way to add / remove tags, if you've the permission to do so.\n\nMore views\n----------\n- The `SimilarEntitiesBox` shows some entities which share the most tags together\n\n- The `TagsCloudView`, a classical, displaying a set of tags appearing more or\n  less big according to the number of tagged entities. It's used by the\n  `TagsCouldBox`, which is not visible by default (user can activate it using\n  their preferences)  but that you can activate by default using the code snippet below:\n\n  .. sourcecode:: python\n\n    from cubicweb_tag.views import TagsCloudBox\n    # make the tags cloud box visible by default\n    TagsCloudBox.visible = True\n\n- The primary view for tags provides a tags merging interface to site administrators,\n  very useful to manage tags on a site where people tend to express the same thing with\n  different words, or spelling.\n\nDocumentation\n-------------\n\nLook in the ``doc/`` subdirectory or read\nhttp://www.cubicweb.org/doc/en/\n",
    "bugtrack_url": null,
    "license": "LGPL",
    "summary": "tag component for the CubicWeb framework",
    "version": "3.1.1",
    "project_urls": {
        "Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-tag"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff3ad35cb6c3747676ec00768e4bd242cb4ba9b802a1fc93e82dadb005781971",
                "md5": "992fe0b8d2c9df5bee5235faafa1e7a9",
                "sha256": "52480e7fde176cec13f052620d75fbfa3db650a6d1d88853dfdfcb34eb9889c5"
            },
            "downloads": -1,
            "filename": "cubicweb_tag-3.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "992fe0b8d2c9df5bee5235faafa1e7a9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.2",
            "size": 45561,
            "upload_time": "2025-07-09T14:50:36",
            "upload_time_iso_8601": "2025-07-09T14:50:36.059768Z",
            "url": "https://files.pythonhosted.org/packages/ff/3a/d35cb6c3747676ec00768e4bd242cb4ba9b802a1fc93e82dadb005781971/cubicweb_tag-3.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "07f74a57a7d742887c9e271d7c51ae169421e698301274b3c4d8537cb2a53a6f",
                "md5": "553580d169270b8e0b3218c7f2402521",
                "sha256": "c38348d585034dbcbca87fce325d96497fd073c5aec5afc98ceec8a9960394aa"
            },
            "downloads": -1,
            "filename": "cubicweb_tag-3.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "553580d169270b8e0b3218c7f2402521",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.2",
            "size": 46468,
            "upload_time": "2025-07-09T14:50:37",
            "upload_time_iso_8601": "2025-07-09T14:50:37.315068Z",
            "url": "https://files.pythonhosted.org/packages/07/f7/4a57a7d742887c9e271d7c51ae169421e698301274b3c4d8537cb2a53a6f/cubicweb_tag-3.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 14:50:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cubicweb-tag"
}
        
Elapsed time: 1.23782s