Summary
-------
The `comment` cube provides threadable comments feature.
It is a CubicWeb component. CubicWeb is a semantic web application
framework, see http://www.cubicweb.org
Install
-------
Auto-install from sources prefered with *pip/Distribute*::
pip install cubicweb-comment
If you have troubles, use *easy_install/setuptools* and eggs::
easy_install cubicweb-comment
You can install the package manually from the uncompressed
`tarball <http://www.cubicweb.org/project/cubicweb-comment>`_::
python setup.py install # auto-install dependencies
If you don't want the dependancies to be installed automaticly, 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
-----
This cube creates a new entity type called `Comment` which could basically be
read by every body but only added by application's users.
It also defines a relation `comments` which provides the ability to add a
`Comment` which `comments` a `Comment`.
To use this cube, you want to add the relation `comments` on the entity type
you want to be able to comment. For instance, let's say your cube defines a
schema for a blog. You want all the blog entries to be commentable.
Here is how to define it in your schema:
.. sourcecode:: python
from yams.buildobjs import RelationDefinition
class comments(RelationDefinition):
subject = 'Comment'
object = 'BlogEntry'
cardinality = '1*'
Once this relation is defined, you can post comments and view threadable
comments automatically on blog entry's primary view.
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-comment",
"name": "cubicweb-comment",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Logilab",
"author_email": "contact@logilab.fr",
"download_url": "https://files.pythonhosted.org/packages/b7/f8/8325ebeab2f2314ba181b5d6ecd5d373a0d20879763b99c5da0b8016ca1d/cubicweb-comment-3.0.0.tar.gz",
"platform": null,
"description": "Summary\n-------\n\nThe `comment` cube provides threadable comments feature.\n\nIt is a CubicWeb component. CubicWeb is a semantic web application\nframework, see http://www.cubicweb.org\n\n\nInstall\n-------\n\nAuto-install from sources prefered with *pip/Distribute*::\n\n pip install cubicweb-comment\n\nIf you have troubles, use *easy_install/setuptools* and eggs::\n\n easy_install cubicweb-comment\n\nYou can install the package manually from the uncompressed\n`tarball <http://www.cubicweb.org/project/cubicweb-comment>`_::\n\n python setup.py install # auto-install dependencies\n\nIf you don't want the dependancies to be installed automaticly, 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\nThis cube creates a new entity type called `Comment` which could basically be\nread by every body but only added by application's users.\nIt also defines a relation `comments` which provides the ability to add a\n`Comment` which `comments` a `Comment`.\n\nTo use this cube, you want to add the relation `comments` on the entity type\nyou want to be able to comment. For instance, let's say your cube defines a\nschema for a blog. You want all the blog entries to be commentable.\nHere is how to define it in your schema:\n\n.. sourcecode:: python\n\n from yams.buildobjs import RelationDefinition\n class comments(RelationDefinition):\n subject = 'Comment'\n object = 'BlogEntry'\n cardinality = '1*'\n\nOnce this relation is defined, you can post comments and view threadable\ncomments automatically on blog entry's primary view.\n\nDocumentation\n-------------\n\nLook in the ``doc/`` subdirectory or read\nhttp://www.cubicweb.org/doc/en/\n",
"bugtrack_url": null,
"license": "LGPL",
"summary": "commenting system for the CubicWeb framework",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://forge.extranet.logilab.fr/cubicweb/cubes/cubicweb-comment"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95c69d83ba59b6b65dbeb4a1f4e951946c395022691ada1b7aedce3a762e6e1e",
"md5": "252d55e75e7a839a489957900d1a8cfe",
"sha256": "78d575d3772375257b2ffa7dde4dbb3322584b2dd2cb018dd8151106f74e0b4c"
},
"downloads": -1,
"filename": "cubicweb_comment-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "252d55e75e7a839a489957900d1a8cfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 60778,
"upload_time": "2023-07-25T09:34:16",
"upload_time_iso_8601": "2023-07-25T09:34:16.269149Z",
"url": "https://files.pythonhosted.org/packages/95/c6/9d83ba59b6b65dbeb4a1f4e951946c395022691ada1b7aedce3a762e6e1e/cubicweb_comment-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7f88325ebeab2f2314ba181b5d6ecd5d373a0d20879763b99c5da0b8016ca1d",
"md5": "3cf5d0e178869b476a7ed1ac2e3e32cb",
"sha256": "2f6f8e90454ae5b7bddc4bd66afe582b840637e350794d61df0f0a42d7eec135"
},
"downloads": -1,
"filename": "cubicweb-comment-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3cf5d0e178869b476a7ed1ac2e3e32cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 62895,
"upload_time": "2023-07-25T09:34:17",
"upload_time_iso_8601": "2023-07-25T09:34:17.576621Z",
"url": "https://files.pythonhosted.org/packages/b7/f8/8325ebeab2f2314ba181b5d6ecd5d373a0d20879763b99c5da0b8016ca1d/cubicweb-comment-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-25 09:34:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cubicweb-comment"
}
JSON