Metadata-Version: 2.4
Name: xchem-ta-auth-client
Version: 1.0.0rc1
Summary: The ISPyB Target Access Authenticator Client
Author-email: Alan Christie <achristie@informaticsmatters.com>
Maintainer-email: Alan Christie <achristie@informaticsmatters.com>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/xchem/fragalysis-target-access-authenticator-python-client.git
Keywords: api
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3,>=2.32.4
Dynamic: license-file

# fragalysis-target-access-authenticator-python-client

![PyPI - Version](https://img.shields.io/pypi/v/xchem-ta-auth-client)

![release](https://github.com/xchem/fragalysis-target-access-authenticator-python-client/actions/workflows/release.yaml/badge.svg)


A simple Python 3 client to simplify access to the authenticator,
providing the following functions: -

```python
def get_auth_target_access(username: str) -> set[str]:
    [...]
def get_auth_version() -> TasAuthVersionGetResponse:
    [...]
def get_auth_ping() -> TasAuthPingGetResponse:
    [...]
```

The module requires two items, extracted from the environment: -

-   `TA_AUTH_SERVICE` - The service hostname. In cluster this might be
    `http://auth.ta-authenticator.svc` (an internal connection that is expected to
    comply with http:// protocol)
-   `TA_AUTH_QUERY_KEY` - A 'secret' key the service expects in request headers.

## The authenticator service
See: -

-   https://github.com/xchem/fragalysis-ispyb-target-access-authenticator
-   https://github.com/xchem/fragalysis-mock-target-access-authenticator

---
