Metadata-Version: 2.1
Name: NEMO-user-details
Version: 1.10.1
Summary: User details plugin for NEMO
Author-email: Atlantis Labs LLC <atlantis@atlantislabs.io>
License: MIT License
        
        Copyright (c) 2023 Atlantis Labs LLC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details
Project-URL: Changelog, https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details/-/releases
Project-URL: Issues, https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details/-/issues
Project-URL: CI, https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details/-/pipelines
Keywords: NEMO
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: Django :: 4.2
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django
Requires-Dist: requests
Requires-Dist: djangorestframework
Provides-Extra: nemo-ce
Requires-Dist: NEMO-CE>=2.4.0; extra == "nemo-ce"
Provides-Extra: nemo
Requires-Dist: NEMO>=5.5.0; extra == "nemo"
Provides-Extra: dev-tools
Requires-Dist: pre-commit; extra == "dev-tools"
Requires-Dist: djlint; extra == "dev-tools"
Requires-Dist: black; extra == "dev-tools"

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/NEMO-user-details?label=python)](https://www.python.org/downloads/release/python-3110/)
[![PyPI](https://img.shields.io/pypi/v/nemo-user-details?label=pypi%20version)](https://pypi.org/project/NEMO-User-Details/)

# NEMO User Details

This plugin for NEMO adds extra fields to users.

The following fields can be enabled in `Customization -> User details`:
* employee id
* ORCID
* phone number
* emergency contact
* groups (from django authentication groups)
* gender
* race
* ethnicity
* education level

If `groups` are enabled, there will also be a new option in `email broadcast` to email based on the groups they belong to.

# Installation

`pip install NEMO-user-details`

`django-admin migrate NEMO_user_details`

# Add NEMO User Details

in `settings.py` add to `INSTALLED_APPS`:

```python
INSTALLED_APPS = [
    '...',
    'NEMO_user_details',
    '...'
]
```

to track changes to details with auditlog, in `settings.py` add to `AUDITLOG_INCLUDE_TRACKING_MODELS`:
```python
AUDITLOG_INCLUDE_TRACKING_MODELS = (
    '...',
    "NEMO_user_details.UserDetails",
    '...',
)
```

# Usage
Go to `Detailed administration` to add choices for each field if needed (groups, gender, ethnicity, race, education level).

Then go to `Customization -> User details` and select which fields you want to enable and require.

Then simply navigate to the `User` page in the `Administration` menu and the new fields will be available.

### NEMO Compatibility

NEMO >= 5.5.0 & NEMO-CE >= 2.4.0 ----> NEMO-user-details >= 1.9.0

NEMO >= 4.7.0 & NEMO-CE >= 1.7.0 ----> NEMO-user-details >= 1.7.0

NEMO >= 4.5.0 & NEMO-CE >= 1.2.0 ----> NEMO-user-details >= 1.6.0
