Metadata-Version: 2.1
Name: igwn-auth-utils
Version: 0.1.0
Summary: Authorisation utilities for IGWN
Home-page: https://github.com/duncanmmacleod/igwn-auth-utils
Author: Duncan Macleod
Maintainer: Duncan Macleod
Maintainer-email: duncan.macleod@ligo.org
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/duncanmmacleod/igwn-auth-utils/issues/
Project-URL: Documentation, https://igwn-auth-utils.readthedocs.io
Project-URL: Source Code, https://github.com/duncanmmacleod/igwn-auth-utils.git
Description: # `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.
        
        ## Development status
        
        [![Build status](https://github.com/duncanmmacleod/igwn-auth-utils/actions/workflows/test.yml/badge.svg)](https://github.com/duncanmmacleod/igwn-auth-utils/actions/workflows/test.yml)
        [![codecov](https://codecov.io/gh/duncanmmacleod/igwn-auth-utils/branch/main/graph/badge.svg?token=kBk2fNinuS)](https://codecov.io/gh/duncanmmacleod/igwn-auth-utils)
        [![Maintainability](https://api.codeclimate.com/v1/badges/8f6c07f0fc8c33015aef/maintainability)](https://codeclimate.com/github/duncanmmacleod/igwn-auth-utils/maintainability)
        [![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>
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: test
