Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/collective/collective.person
A Person content type for Plone.
https://github.com/collective/collective.person
plone plone-addon plone6
Last synced: about 2 months ago
JSON representation
A Person content type for Plone.
- Host: GitHub
- URL: https://github.com/collective/collective.person
- Owner: collective
- License: gpl-2.0
- Created: 2013-07-16T08:40:03.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T15:37:53.000Z (9 months ago)
- Last Synced: 2024-11-09T00:55:58.704Z (about 2 months ago)
- Topics: plone, plone-addon, plone6
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 2
- Watchers: 121
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Person content type for Plone
[](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)
## 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
```
### 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
profile-collective.person:default
```
## 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.