NEMO-user-details

Name	NEMO-user-details JSON
Version	1.9.0 JSON
	download
home_page	https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details
Summary	Install user details plugin for NEMO
upload_time	2024-04-17 18:44:10
maintainer	None
docs_url	None
author	Atlantis Labs LLC
requires_python	>=3.8
license	MIT
keywords	nemo
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![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

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).

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details",
    "name": "NEMO-user-details",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "NEMO",
    "author": "Atlantis Labs LLC",
    "author_email": "atlantis@atlantislabs.io",
    "download_url": null,
    "platform": null,
    "description": "[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/NEMO-user-details?label=python)](https://www.python.org/downloads/release/python-3110/)\n[![PyPI](https://img.shields.io/pypi/v/nemo-user-details?label=pypi%20version)](https://pypi.org/project/NEMO-User-Details/)\n\n# NEMO User Details\n\nThis plugin for NEMO adds extra fields to users.\n\nThe following fields can be enabled in `Customization -> User details`:\n* employee id\n* ORCID\n* phone number\n* emergency contact\n* groups (from django authentication groups)\n* gender\n* race\n* ethnicity\n\nIf `groups` are enabled, there will also be a new option in `email broadcast` to email based on the groups they belong to.\n\n# Installation\n\n`pip install NEMO-user-details`\n\n`django-admin migrate NEMO_user_details`\n\n# Add NEMO User Details\n\nin `settings.py` add to `INSTALLED_APPS`:\n\n```python\nINSTALLED_APPS = [\n    '...',\n    'NEMO_user_details',\n    '...'\n]\n```\n\nto track changes to details with auditlog, in `settings.py` add to `AUDITLOG_INCLUDE_TRACKING_MODELS`:\n```python\nAUDITLOG_INCLUDE_TRACKING_MODELS = (\n    '...',\n    \"NEMO_user_details.UserDetails\",\n    '...',\n)\n```\n\n# Usage\nGo to `Detailed administration` to add choices for each field if needed (groups, gender, ethnicity, race).\n\nThen go to `Customization -> User details` and select which fields you want to enable and require.\n\nThen simply navigate to the `User` page in the `Administration` menu and the new fields will be available.\n\n### NEMO Compatibility\n\nNEMO >= 5.5.0 & NEMO-CE >= 2.4.0 ----> NEMO-user-details >= 1.9.0\n\nNEMO >= 4.7.0 & NEMO-CE >= 1.7.0 ----> NEMO-user-details >= 1.7.0\n\nNEMO >= 4.5.0 & NEMO-CE >= 1.2.0 ----> NEMO-user-details >= 1.6.0\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Install user details plugin for NEMO",
    "version": "1.9.0",
    "project_urls": {
        "Homepage": "https://gitlab.com/nemo-community/atlantis-labs/nemo-user-details"
    },
    "split_keywords": [
        "nemo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8dcb969bc92d952bb5c2a1e87dd58d13e3999361676f6504d01263b7e9996697",
                "md5": "4cf9b4d1ab62c178da6918c08a366620",
                "sha256": "d8a6df15198a0550ca1e0808343191495286241fbc5fa392dda5f3b9fc5b1f92"
            },
            "downloads": -1,
            "filename": "NEMO_user_details-1.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4cf9b4d1ab62c178da6918c08a366620",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21612,
            "upload_time": "2024-04-17T18:44:10",
            "upload_time_iso_8601": "2024-04-17T18:44:10.059486Z",
            "url": "https://files.pythonhosted.org/packages/8d/cb/969bc92d952bb5c2a1e87dd58d13e3999361676f6504d01263b7e9996697/NEMO_user_details-1.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 18:44:10",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "nemo-community",
    "gitlab_project": "atlantis-labs",
    "lcname": "nemo-user-details"
}