igwn-auth-utils

Name	igwn-auth-utils JSON
Version	1.1.0 JSON
	download
home_page	https://git.ligo.org/computing/igwn-auth-utils
Summary	Authorisation utilities for IGWN
upload_time	2023-10-18 14:49:51
maintainer	Duncan Macleod
docs_url	None
author	Duncan Macleod
requires_python	>=3.6
license	BSD-3-Clause
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # `igwn-auth-utils`

Python library functions to simplify using IGWN authorisation credentials.

<https://igwn-auth-utils.readthedocs.io/>

This project is primarily aimed at discovering X.509 credentials and
SciTokens for use with HTTP(S) requests to IGWN-operated services.

## Release status

[![PyPI version](https://badge.fury.io/py/igwn-auth-utils.svg)](http://badge.fury.io/py/igwn-auth-utils)
[![License](https://img.shields.io/pypi/l/igwn-auth-utils.svg)](https://git.ligo.org/computing/igwn-auth-utils/blob/main/LICENSE)
[![DOI](https://zenodo.org/badge/383081505.svg)](https://zenodo.org/badge/latestdoi/383081505)

## Development status

[![Build status](https://git.ligo.org/computing/igwn-auth-utils/badges/main/pipeline.svg)](https://git.ligo.org/computing/igwn-auth-utils/-/pipelines)
![Code coverage](https://git.ligo.org/computing/igwn-auth-utils/badges/main/coverage.svg)
[![Documentation Status](https://readthedocs.org/projects/igwn-auth-utils/badge/?version=latest)](https://igwn-auth-utils.readthedocs.io/en/latest/?badge=latest)

## Installation

The best way to install the latest release is using
[`conda`](https://conda.io/) with the
[`conda-forge`](https://conda-forge.org) channel enabled:

```bash
conda install -c conda-forge igwn-auth-utils
```

The latest release can also be installed using `pip`:

```bash
python -m pip install igwn-auth-utils
```

## Basic usage

To discover an X.509 user credential (proxy) **location**:

```python
>>> from igwn_auth_utils import find_x509_credentials
>>> print(find_x509_credentials())
('/tmp/x509up_u1000', '/tmp/x509up_u1000')
```

To discover (**and deserialise**) a SciToken for a specific
purpose (`audience` and `scope`):

```python
>>> from igwn_auth_utils import find_scitoken
>>> print(find_scitoken("myservice", "read:/mydata"))
<scitokens.scitokens.SciToken object at 0x7fe99ab792e0>
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://git.ligo.org/computing/igwn-auth-utils",
    "name": "igwn-auth-utils",
    "maintainer": "Duncan Macleod",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "duncan.macleod@ligo.org",
    "keywords": "",
    "author": "Duncan Macleod",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/ed/c9/2e1462f795511c4685c29c5f870192b2208189d41c8ac3f9d43e80bd7bad/igwn-auth-utils-1.1.0.tar.gz",
    "platform": null,
    "description": "# `igwn-auth-utils`\n\nPython library functions to simplify using IGWN authorisation credentials.\n\n<https://igwn-auth-utils.readthedocs.io/>\n\nThis project is primarily aimed at discovering X.509 credentials and\nSciTokens for use with HTTP(S) requests to IGWN-operated services.\n\n## Release status\n\n[![PyPI version](https://badge.fury.io/py/igwn-auth-utils.svg)](http://badge.fury.io/py/igwn-auth-utils)\n[![License](https://img.shields.io/pypi/l/igwn-auth-utils.svg)](https://git.ligo.org/computing/igwn-auth-utils/blob/main/LICENSE)\n[![DOI](https://zenodo.org/badge/383081505.svg)](https://zenodo.org/badge/latestdoi/383081505)\n\n## Development status\n\n[![Build status](https://git.ligo.org/computing/igwn-auth-utils/badges/main/pipeline.svg)](https://git.ligo.org/computing/igwn-auth-utils/-/pipelines)\n![Code coverage](https://git.ligo.org/computing/igwn-auth-utils/badges/main/coverage.svg)\n[![Documentation Status](https://readthedocs.org/projects/igwn-auth-utils/badge/?version=latest)](https://igwn-auth-utils.readthedocs.io/en/latest/?badge=latest)\n\n## Installation\n\nThe best way to install the latest release is using\n[`conda`](https://conda.io/) with the\n[`conda-forge`](https://conda-forge.org) channel enabled:\n\n```bash\nconda install -c conda-forge igwn-auth-utils\n```\n\nThe latest release can also be installed using `pip`:\n\n```bash\npython -m pip install igwn-auth-utils\n```\n\n## Basic usage\n\nTo discover an X.509 user credential (proxy) **location**:\n\n```python\n>>> from igwn_auth_utils import find_x509_credentials\n>>> print(find_x509_credentials())\n('/tmp/x509up_u1000', '/tmp/x509up_u1000')\n```\n\nTo discover (**and deserialise**) a SciToken for a specific\npurpose (`audience` and `scope`):\n\n```python\n>>> from igwn_auth_utils import find_scitoken\n>>> print(find_scitoken(\"myservice\", \"read:/mydata\"))\n<scitokens.scitokens.SciToken object at 0x7fe99ab792e0>\n```\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Authorisation utilities for IGWN",
    "version": "1.1.0",
    "project_urls": {
        "Bug Tracker": "https://git.ligo.org/computing/igwn-auth-utils/-/issues/",
        "Documentation": "https://igwn-auth-utils.readthedocs.io",
        "Homepage": "https://git.ligo.org/computing/igwn-auth-utils",
        "Source Code": "https://git.ligo.org/computing/igwn-auth-utils.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fdeb3ecb441fcbe6040412300a7b983d1d04d9d04f2d092a82a4dd34dd0d0dad",
                "md5": "62dac29e973d2266e70e2bef747ad6b6",
                "sha256": "7ddd88292c8f952f096ed71b64ce3ca2054a24f442cfc0e3f3aef52a18a1460a"
            },
            "downloads": -1,
            "filename": "igwn_auth_utils-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62dac29e973d2266e70e2bef747ad6b6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 26024,
            "upload_time": "2023-10-18T14:49:50",
            "upload_time_iso_8601": "2023-10-18T14:49:50.171671Z",
            "url": "https://files.pythonhosted.org/packages/fd/eb/3ecb441fcbe6040412300a7b983d1d04d9d04f2d092a82a4dd34dd0d0dad/igwn_auth_utils-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "edc92e1462f795511c4685c29c5f870192b2208189d41c8ac3f9d43e80bd7bad",
                "md5": "212d16f9e63b6b87489e89fe47922cfe",
                "sha256": "f993f0ed8b83538a14df7dda540eb2dcaebd26aa0b058fffa105cd6de2d16e69"
            },
            "downloads": -1,
            "filename": "igwn-auth-utils-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "212d16f9e63b6b87489e89fe47922cfe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 35411,
            "upload_time": "2023-10-18T14:49:51",
            "upload_time_iso_8601": "2023-10-18T14:49:51.547092Z",
            "url": "https://files.pythonhosted.org/packages/ed/c9/2e1462f795511c4685c29c5f870192b2208189d41c8ac3f9d43e80bd7bad/igwn-auth-utils-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-18 14:49:51",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "igwn-auth-utils"
}