gen3users

Name	gen3users JSON
Version	1.1.1 JSON
	download
home_page	https://github.com/uc-cdis/gen3users
Summary	Utils for Gen3 Commons user management
upload_time	2024-07-09 19:53:15
maintainer	None
docs_url	None
author	CTDS UChicago
requires_python	<4.0,>=3.9
license	Apache-2.0
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # gen3users

Utils for Gen3 commons user management.

## user.yaml validation

Validate a `user.yaml` file using the CLI:
```
pip install gen3users
gen3users validate first_user.yaml second_user.yaml
```

Validate a `user.yaml` file in a Python script:
```
from gen3users.validation import validate_user_yaml

file_name = "my-gen3-commons/user.yaml"
with open(file_name, "r") as f:
    user_yaml = f.read()
    validate_user_yaml(user_yaml, file_name)
```

## user.yaml conversion

Converts a `user.yaml` file from the old format to the new ABAC-based centralized auth format, required by the latest Fence and Arborist.

Convert a `user.yaml` file using the CLI:
```
pip install gen3users
gen3users convert old_user.yaml [new_user.yaml]
```

Convert a `user.yaml` in a Python script:
```
from gen3users.conversion import convert_old_user_yaml_to_new_user_yaml

src_file_name = "my-gen3-commons/old_user.yaml"
dst_file_name = "my-gen3-commons/new_user.yaml"
with open (src_file_name, "r") as f:
        user_yaml = f.read()
        convert_old_user_yaml_to_new_user_yaml(user_yaml, dst_file_name)

```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/uc-cdis/gen3users",
    "name": "gen3users",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "CTDS UChicago",
    "author_email": "cdis@uchicago.edu",
    "download_url": "https://files.pythonhosted.org/packages/56/e5/6bc8024b829d344601193bdd8552f0e883b6809e3046550f7da05042f1ed/gen3users-1.1.1.tar.gz",
    "platform": null,
    "description": "# gen3users\n\nUtils for Gen3 commons user management.\n\n## user.yaml validation\n\nValidate a `user.yaml` file using the CLI:\n```\npip install gen3users\ngen3users validate first_user.yaml second_user.yaml\n```\n\nValidate a `user.yaml` file in a Python script:\n```\nfrom gen3users.validation import validate_user_yaml\n\nfile_name = \"my-gen3-commons/user.yaml\"\nwith open(file_name, \"r\") as f:\n    user_yaml = f.read()\n    validate_user_yaml(user_yaml, file_name)\n```\n\n## user.yaml conversion\n\nConverts a `user.yaml` file from the old format to the new ABAC-based centralized auth format, required by the latest Fence and Arborist.\n\nConvert a `user.yaml` file using the CLI:\n```\npip install gen3users\ngen3users convert old_user.yaml [new_user.yaml]\n```\n\nConvert a `user.yaml` in a Python script:\n```\nfrom gen3users.conversion import convert_old_user_yaml_to_new_user_yaml\n\nsrc_file_name = \"my-gen3-commons/old_user.yaml\"\ndst_file_name = \"my-gen3-commons/new_user.yaml\"\nwith open (src_file_name, \"r\") as f:\n        user_yaml = f.read()\n        convert_old_user_yaml_to_new_user_yaml(user_yaml, dst_file_name)\n\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Utils for Gen3 Commons user management",
    "version": "1.1.1",
    "project_urls": {
        "Homepage": "https://github.com/uc-cdis/gen3users",
        "Repository": "https://github.com/uc-cdis/gen3users"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08d7327f0d4aa4d654950d7f81d38e9330a94959f452eb45608410a486c6e95a",
                "md5": "24a833d6905c66b3e0f48b9cdf6f71ce",
                "sha256": "5a38ba90c8cef5f7c4ed6ae2f1f1d733524d48b1b2c60e66db8537e36194faab"
            },
            "downloads": -1,
            "filename": "gen3users-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "24a833d6905c66b3e0f48b9cdf6f71ce",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 18508,
            "upload_time": "2024-07-09T19:53:13",
            "upload_time_iso_8601": "2024-07-09T19:53:13.871442Z",
            "url": "https://files.pythonhosted.org/packages/08/d7/327f0d4aa4d654950d7f81d38e9330a94959f452eb45608410a486c6e95a/gen3users-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56e56bc8024b829d344601193bdd8552f0e883b6809e3046550f7da05042f1ed",
                "md5": "6d0810bd019f9c08527762252dddcfd3",
                "sha256": "6636ff127ce145f9104fc72358dd17de54b19be19ae45b89e13876c0adcf4ba0"
            },
            "downloads": -1,
            "filename": "gen3users-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6d0810bd019f9c08527762252dddcfd3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 15193,
            "upload_time": "2024-07-09T19:53:15",
            "upload_time_iso_8601": "2024-07-09T19:53:15.352520Z",
            "url": "https://files.pythonhosted.org/packages/56/e5/6bc8024b829d344601193bdd8552f0e883b6809e3046550f7da05042f1ed/gen3users-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-09 19:53:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "uc-cdis",
    "github_project": "gen3users",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gen3users"
}