Metadata-Version: 2.1
Name: cognito-client
Version: 0.0.1
Summary: A small example package
Home-page: https://github.com/developmentseed/cognito_client
Author: Anthony Lukach
Author-email: Anthony Lukach <anthony@developmentseed.com>, Aimee Barciauskas <aimee@developmentseed.com>
License: MIT
Project-URL: Homepage, https://github.com/developmentseed/cognito_client
Project-URL: Bug Tracker, https://github.com/developmentseed/cognito_client/issues
Keywords: Cognito AWS
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# Cognito Client

A client to smooth over process of common authentication scenarios
using AWS Cognito. Intended to be used within an interactive terminal 
environment (e.g. Python Notebook, CLI).

## Usage

### Install

```
pip install cognito_client
```

### Use

Create an `.env` file in the format of `examples/env.example` and create a client in the same directory:

```python
client = CognitoClient()
```

OR pass the Cognito identifiers as arguments to the function:

```python
client = CognitoClient(
    client_id="XXX",
    user_pool_id="us-west-XXX",
    identity_pool_id="us-west-2:XXX",
)
```

See `examples/temporary-credentials-example.ipynb`.
