Metadata-Version: 2.1
Name: aarc_g002_entitlement
Version: 0.2.5
Summary: Parse and compare entitlements according to the AARC-G002 recommendation (https://aarc-project.eu/guidelines/aarc-g002)
Home-page: https://github.com/kit-scc/aarc-g002-entitlement
Author: Marcus Hardt
Author-email: hardt@kit.edu
License: MIT
Project-URL: Bug Tracker, https://github.com/kit-scc/aarc-g002-entitlement/issues
Project-URL: Documentation, https://aarc-g002-entitlement.readthedocs.io/en/latest/
Description: [![Documentation Status](https://readthedocs.org/projects/aarc-g002-entitlement/badge/?version=latest&token=5f5165c8ebde7726ae9df9f62331a59e7344d6e61a4bb9ea8c97cecfae25f4f3)](https://aarc-g002-entitlement.readthedocs.io/en/latest/?badge=latest)
        # AARC G002 Entitlement Parser
        
        # Introduction
        This package provides a python Class to parse and compare entitlements according
        to the AARC-G002 Recommendation https://aarc-project.eu/guidelines/aarc-g002.
        
        
        # Example
        
        ```python
        from aarc_g002_entitlement import Aarc_g002_entitlement
        
        required = Aarc_g002_entitlement(
            'urn:geant:h-df.de:group:aai-admin',
            strict=False)
        actual = Aarc_g002_entitlement(
            'urn:geant:h-df.de:group:aai-admin:role=member#backupserver.used.for.developmt.de')
        
        # is a user with actual permitted to use a resource which needs required?
        permitted = required.is_contained_in(actual) # True in this case
        
        # are the two entitlements the same?
        equals = required == actual # False in this case
        ```
        
        For more examples: `./example.py`
        
        # Installation
        ```
        pip --user install aarc-g002-entitlement
        ```
        
        # Documentation
        ```
        tox -e docs
        ```
        After this, the documentation should be located at `doc/build/index.html`.
        
        Documentation is also available at [Readthedocs](https://aarc-g002-entitlement.readthedocs.io/en/latest)
        
        # Tests
        Run tests for all supported python versions
        ```
        tox
        ```
        
        # Funding Notice
        The AARC project has received funding from the European Union’s Horizon
        2020 research and innovation programme under grant agreement No 653965 and
        730941.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown; charset=UTF-8
