cubicweb-person


Namecubicweb-person JSON
Version 2.0.1 PyPI version JSON
download
home_pagehttps://www.cubicweb.org/project/cubicweb-person
Summaryperson component for the CubicWeb framework
upload_time2023-08-03 15:37:49
maintainer
docs_urlNone
authorLogilab
requires_python
licenseLGPL
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Summary
-------

`person` provides person informations :

- firstname
- surname / lastname
- civility
- arbitrary text description
- a relation to an email address (NB, the `EmailAddress` entity is
  automatically provided by cubicweb).

If the `addressbook` cube is used, persons will also have *phone* and
*postal_address* relations to store more contact information.

There is a special relation called 'primary_email'. A person can be linked to
multiple email addresses (using the 'use_email' relation). The primary email
must be unique. At the creation of the first email, this relation is
automatically added (though you can change it later, of course).

Recommends
----------

- `addressbook` cube


Usage
-----

In addition of basic entity views, this cube provides :

- *VCardPersonView*, displays a person in the VCard file format
   (.. _VCard on wikipedia: http://en.wikipedia.org/wiki/VCard) .

   This view creates a file called `vcard.vcf` which can be open in
   your addressbook application (Kmail, Thunderbird and so on). In
   order to generate this file, you have to access to a specific view
   using an url address with `?vid=vcard` suffix.

   How to personalize the person primary view in order to add a link
   for the vcard ?

   .. sourcecode:: python

     class PersonalizedPersonPrimaryView(PersonPrimaryView):

         def render_entity_attributes(self, entity):
             super(PersonalizedPersonPrimaryView, self).render_entity_attributes(entity)
             self.w(u'<div><a href="%s">export contact as vcard</a></div>'  % entity.absolute_url(vid='vcard'))

    This view will not be selected by default. You have to registered
    this view or add a selector. For more information, please refer to
    XXX in the doc.

- a *civility facet*, this facet (XXX: ref to facet doc) will be shown
  if a view displays a result set of at least two Person entities with
  different civilities.

Contributing
------------

Information on how to contribute can be found here https://www.logilab.org/Card/contributing

            

Raw data

            {
    "_id": null,
    "home_page": "https://www.cubicweb.org/project/cubicweb-person",
    "name": "cubicweb-person",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Logilab",
    "author_email": "contact@logilab.fr",
    "download_url": "https://files.pythonhosted.org/packages/61/95/ebf2bd073e71d82ac93311c5392c9d90798b918ab929bb0d7a2d2300e674/cubicweb-person-2.0.1.tar.gz",
    "platform": null,
    "description": "Summary\n-------\n\n`person` provides person informations :\n\n- firstname\n- surname / lastname\n- civility\n- arbitrary text description\n- a relation to an email address (NB, the `EmailAddress` entity is\n  automatically provided by cubicweb).\n\nIf the `addressbook` cube is used, persons will also have *phone* and\n*postal_address* relations to store more contact information.\n\nThere is a special relation called 'primary_email'. A person can be linked to\nmultiple email addresses (using the 'use_email' relation). The primary email\nmust be unique. At the creation of the first email, this relation is\nautomatically added (though you can change it later, of course).\n\nRecommends\n----------\n\n- `addressbook` cube\n\n\nUsage\n-----\n\nIn addition of basic entity views, this cube provides :\n\n- *VCardPersonView*, displays a person in the VCard file format\n   (.. _VCard on wikipedia: http://en.wikipedia.org/wiki/VCard) .\n\n   This view creates a file called `vcard.vcf` which can be open in\n   your addressbook application (Kmail, Thunderbird and so on). In\n   order to generate this file, you have to access to a specific view\n   using an url address with `?vid=vcard` suffix.\n\n   How to personalize the person primary view in order to add a link\n   for the vcard ?\n\n   .. sourcecode:: python\n\n     class PersonalizedPersonPrimaryView(PersonPrimaryView):\n\n         def render_entity_attributes(self, entity):\n             super(PersonalizedPersonPrimaryView, self).render_entity_attributes(entity)\n             self.w(u'<div><a href=\"%s\">export contact as vcard</a></div>'  % entity.absolute_url(vid='vcard'))\n\n    This view will not be selected by default. You have to registered\n    this view or add a selector. For more information, please refer to\n    XXX in the doc.\n\n- a *civility facet*, this facet (XXX: ref to facet doc) will be shown\n  if a view displays a result set of at least two Person entities with\n  different civilities.\n\nContributing\n------------\n\nInformation on how to contribute can be found here https://www.logilab.org/Card/contributing\n",
    "bugtrack_url": null,
    "license": "LGPL",
    "summary": "person component for the CubicWeb framework",
    "version": "2.0.1",
    "project_urls": {
        "Homepage": "https://www.cubicweb.org/project/cubicweb-person"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "011308c5142e4bea8d12bc5cc9a193ebf40a572cc1115142f26ba4b9056bf1e7",
                "md5": "f365be39b5dac18519d8a69d7bb10c83",
                "sha256": "f31213e3558b9c243429a511a51dd43a777578d6a99500611f87f270e2ba8c4f"
            },
            "downloads": -1,
            "filename": "cubicweb_person-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f365be39b5dac18519d8a69d7bb10c83",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 53926,
            "upload_time": "2023-08-03T15:37:47",
            "upload_time_iso_8601": "2023-08-03T15:37:47.363795Z",
            "url": "https://files.pythonhosted.org/packages/01/13/08c5142e4bea8d12bc5cc9a193ebf40a572cc1115142f26ba4b9056bf1e7/cubicweb_person-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6195ebf2bd073e71d82ac93311c5392c9d90798b918ab929bb0d7a2d2300e674",
                "md5": "61594277828231fbd5b70038eeea022a",
                "sha256": "7fd2fbcd8e9bd999ae35be53199e15e32202749e5ab7ec2f24872178f41e48f2"
            },
            "downloads": -1,
            "filename": "cubicweb-person-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "61594277828231fbd5b70038eeea022a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 55091,
            "upload_time": "2023-08-03T15:37:49",
            "upload_time_iso_8601": "2023-08-03T15:37:49.735623Z",
            "url": "https://files.pythonhosted.org/packages/61/95/ebf2bd073e71d82ac93311c5392c9d90798b918ab929bb0d7a2d2300e674/cubicweb-person-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-03 15:37:49",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cubicweb-person"
}
        
Elapsed time: 0.10996s