Metadata-Version: 2.2
Name: oauth2flow
Version: 0.1.2
Summary: Client Authenticator for OAuth2
Author-email: Paulo Alexandre <paulo.alexandre@tjdft.jus.br>
License: MIT License
        
        Copyright (c) 2025 Paulo Alexandre
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: requests<3.0.0,>=2.23.0
Requires-Dist: attrs<25.0.0,>=24.3.0

# OAuth2flow Client
Authorization protocol that allows applications to access resources from other applications on the user's behalf.   
Allows applications to gain limited access to user information without sharing credentials.  

## Implements Flow
- [ ] Authorization Code (future)
- [x] Resource Owner Password Credentials
- [ ] Implicit (future)
- [x] Client Credentials

# Quick Started
Install usign pip:  
```bash 
pip install oauth2flow 
```
configure variables before using , let's code.  

## Variables
Environment variables are mandatory for oauth2flow to work in your project, use exports linux or dotenv pypi    
to make them available in the development environment.

**env.file** 
```bash
CLIENT_ID="client" 
CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
REDIRECT_URI=""
AUTHORIZATION_BASE_URL=https://provider.com/auth/realms/{RELM}/protocol/openid-connect/auth
TOKEN_URL=https://provider.com/auth/realms/{RELM}/protocol/openid-connect/token
USERINFO_URL=https://provider.com/auth/realms/{RELM}/protocol/openid-connect/userinfo
INTROSPECTION_URL=https://provider.com/auth/realms/{RELM}/protocol/openid-connect/token/introspect
OPENID_CONFIGURATION_URL=https://provider.com/auth/realms/{RELM}/.well-known/openid-configuration
```

## Documentation

The documentation can be found on Read the Docs at soom.

## Project in devcontainer
Project was built on top of python 3.12 dockenized devcontainer vscode microsoft environment  
```json
"runArgs": ["--env-file",".env"],
```
