<div align="center"><img alt="logo" src="https://raw.githubusercontent.com/collective/collective.person/main/docs/logo.svg" width="100" /></div>
<h1 align="center">Person content type for Plone</h1>
<div align="center">
[](https://pypi.org/project/collective.person/)
[](https://pypi.org/project/collective.person/)
[](https://pypi.org/project/collective.person/)
[](https://pypi.org/project/collective.person/)
[](https://pypi.org/project/collective.person/)
[](https://pypi.org/project/collective.person/)
[](https://github.com/collective/collective.person/actions/workflows/meta.yml)
[](https://github.com/collective/collective.person)
[](https://github.com/collective/collective.person)
</div>
## Features
`collective.person` provides a content type representing a Person.
### Content Types
* `Person`: A content type representing a person
### Behaviors
| name | title | description |
| -- | -- | -- |
| `collective.person.person` | Person Behavior | Fields with basic person information |
| `collective.person.user` | Link Person to Plone User | Adapts a Person to link it to a Plone User |
| `collective.person.namefromusername` | Name from username |Use the username field as name (basis for the id) |
### Permissions
| id | title | Usage |
| -- | -- | -- |
| collective.person.person.add | collective.person: Add Person | Control the creation of a new Person content item |
### Catalog Indexes
This package adds Indexes and Metadata to Portal Catalog.
| Content Attribute | Index Type | Metadata | Comment |
| -- | -- | -- | -- |
| roles | KeywordIndex | ✅ | -- |
| username | FieldIndex | ✅ | Used when `collective.person.user` behavior is enabled |
## See it in action
This package is being used by the following sites:
* TODO
## Documentation
### Installation
Add `collective.person` as a dependency on your package's `setup.py`
```python
install_requires = [
"collective.person",
"Plone",
"plone.restapi",
"setuptools",
],
```
Also, add `collective.person` to your package's `configure.zcml` (or `dependencies.zcml`):
```xml
<include package="collective.person" />
```
### Generic Setup
To automatically enable this package when your add-on is installed, add the following line inside the package's `profiles/default/metadata.xml` `dependencies` element:
```xml
<dependency>profile-collective.person:default</dependency>
```
## Source Code and Contributions
We welcome contributions to `collective.person`.
You can create an issue in the issue tracker, or contact a maintainer.
- [Issue Tracker](https://github.com/collective/collective.person/issues)
- [Source Code](https://github.com/collective/collective.person/)
### Development setup
You need a working Python environment version 3.8 or later.
Then install the dependencies and a development instance using:
```bash
make install
```
By default, we use the latest Plone version in the 6.x series.
### Update translations
```bash
make i18n
```
### Format codebase
```bash
make format
```
### Run tests
```bash
make test
```
## License
The project is licensed under GPLv2.
# Changelog
<!--
You should *NOT* be adding new change log entries to this file.
You should create a file in the news directory instead.
For helpful instructions, please see:
https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
-->
<!-- towncrier release notes start -->
## 1.0.0a2 (2023-06-21)
### New features:
- Implement `Person` content type @ericof person
- Add pt_BR translation @ericof pt_BR
- Implement `collective.person.user` behavior @ericof user-behavior
## 1.0.0 (unreleased)
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.person",
"name": "collective.person",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Python Plone CMS",
"author": "Plone Community",
"author_email": "ericof@plone.org",
"download_url": "https://files.pythonhosted.org/packages/ec/d4/46b11633b839c4a5a697be032d0c6ec44e4c4d6fbb3a662eb00210307f7b/collective.person-1.0.0a2.tar.gz",
"platform": null,
"description": "\n<div align=\"center\"><img alt=\"logo\" src=\"https://raw.githubusercontent.com/collective/collective.person/main/docs/logo.svg\" width=\"100\" /></div>\n\n<h1 align=\"center\">Person content type for Plone</h1>\n\n<div align=\"center\">\n\n[](https://pypi.org/project/collective.person/)\n[](https://pypi.org/project/collective.person/)\n[](https://pypi.org/project/collective.person/)\n[](https://pypi.org/project/collective.person/)\n[](https://pypi.org/project/collective.person/)\n\n\n[](https://pypi.org/project/collective.person/)\n\n[](https://github.com/collective/collective.person/actions/workflows/meta.yml)\n\n\n[](https://github.com/collective/collective.person)\n[](https://github.com/collective/collective.person)\n\n</div>\n\n## Features\n\n`collective.person` provides a content type representing a Person.\n\n### Content Types\n\n* `Person`: A content type representing a person\n\n### Behaviors\n\n| name | title | description |\n| -- | -- | -- |\n| `collective.person.person` | Person Behavior | Fields with basic person information |\n| `collective.person.user` | Link Person to Plone User | Adapts a Person to link it to a Plone User |\n| `collective.person.namefromusername` | Name from username |Use the username field as name (basis for the id) |\n\n### Permissions\n\n| id | title | Usage |\n| -- | -- | -- |\n| collective.person.person.add | collective.person: Add Person | Control the creation of a new Person content item |\n\n### Catalog Indexes\n\nThis package adds Indexes and Metadata to Portal Catalog.\n\n| Content Attribute | Index Type | Metadata | Comment |\n| -- | -- | -- | -- |\n| roles | KeywordIndex | \u2705 | -- |\n| username | FieldIndex | \u2705 | Used when `collective.person.user` behavior is enabled |\n\n## See it in action\n\nThis package is being used by the following sites:\n\n* TODO\n\n## Documentation\n\n### Installation\n\nAdd `collective.person` as a dependency on your package's `setup.py`\n\n```python\n install_requires = [\n \"collective.person\",\n \"Plone\",\n \"plone.restapi\",\n \"setuptools\",\n ],\n```\n\nAlso, add `collective.person` to your package's `configure.zcml` (or `dependencies.zcml`):\n\n```xml\n<include package=\"collective.person\" />\n```\n\n### Generic Setup\n\nTo automatically enable this package when your add-on is installed, add the following line inside the package's `profiles/default/metadata.xml` `dependencies` element:\n\n```xml\n <dependency>profile-collective.person:default</dependency>\n```\n\n## Source Code and Contributions\n\nWe welcome contributions to `collective.person`.\n\nYou can create an issue in the issue tracker, or contact a maintainer.\n\n- [Issue Tracker](https://github.com/collective/collective.person/issues)\n- [Source Code](https://github.com/collective/collective.person/)\n\n\n### Development setup\n\nYou need a working Python environment version 3.8 or later.\n\nThen install the dependencies and a development instance using:\n\n```bash\nmake install\n```\n\nBy default, we use the latest Plone version in the 6.x series.\n\n### Update translations\n\n```bash\nmake i18n\n```\n### Format codebase\n\n```bash\nmake format\n```\n### Run tests\n\n```bash\nmake test\n```\n\n## License\n\nThe project is licensed under GPLv2.\n\n\n# Changelog\n\n<!--\n You should *NOT* be adding new change log entries to this file.\n You should create a file in the news directory instead.\n For helpful instructions, please see:\n https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst\n-->\n\n<!-- towncrier release notes start -->\n\n## 1.0.0a2 (2023-06-21)\n\n\n### New features:\n\n- Implement `Person` content type @ericof person\n- Add pt_BR translation @ericof pt_BR\n- Implement `collective.person.user` behavior @ericof user-behavior\n\n\n## 1.0.0 (unreleased)\n\n\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "A Person content type for Plone.",
"version": "1.0.0a2",
"project_urls": {
"Homepage": "https://github.com/collective/collective.person",
"PyPI": "https://pypi.python.org/pypi/collective.person",
"Source": "https://github.com/collective/collective.person",
"Tracker": "https://github.com/collective/collective.person/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88f46778c290767a519b12a0c360c6bd9371a889f8da3e4b2a5e94d06786d829",
"md5": "4e73fdfa0dbad45fe84f9524fcd10161",
"sha256": "607ad461b281e5f1c53d276df12d3028f78c22e0b3185be536290bf807f86b47"
},
"downloads": -1,
"filename": "collective.person-1.0.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e73fdfa0dbad45fe84f9524fcd10161",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 43203,
"upload_time": "2023-06-21T23:38:44",
"upload_time_iso_8601": "2023-06-21T23:38:44.836448Z",
"url": "https://files.pythonhosted.org/packages/88/f4/6778c290767a519b12a0c360c6bd9371a889f8da3e4b2a5e94d06786d829/collective.person-1.0.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecd446b11633b839c4a5a697be032d0c6ec44e4c4d6fbb3a662eb00210307f7b",
"md5": "6f30cfe98d322b4e91bcd73b44cb108d",
"sha256": "cb255c89f1e56c4dd2d045d791b02aa71a26b848439d432b21f2b7baee9029c3"
},
"downloads": -1,
"filename": "collective.person-1.0.0a2.tar.gz",
"has_sig": false,
"md5_digest": "6f30cfe98d322b4e91bcd73b44cb108d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 36206,
"upload_time": "2023-06-21T23:38:46",
"upload_time_iso_8601": "2023-06-21T23:38:46.893740Z",
"url": "https://files.pythonhosted.org/packages/ec/d4/46b11633b839c4a5a697be032d0c6ec44e4c4d6fbb3a662eb00210307f7b/collective.person-1.0.0a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-21 23:38:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.person",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "collective.person"
}
JSON
