Initial commit

Author: easySSP-dev

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Ruff and Mypy Checks
+
+on:
+  push:
+    branches:
+      - '**' # Triggers on all branches but not tag push
+  pull_request:  # Triggers on all PRs
+
+jobs:
+  lint:
+    name: Run Ruff and Mypy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install uv
+          uv sync --group lint
+
+      - name: Run Ruff
+        run: |
+          uv run --frozen python -m ruff check
+
+      - name: Run Mypy
+        run: |
+          uv run --frozen python -m mypy

.github/workflows/python-publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine check dist/*
+          twine upload dist/*

.gitignore

@@ -0,0 +1,3 @@
+.idea/
+venv/
+/dist/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 eXXcellent solutions
+
+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.

README-pypi.md

@@ -0,0 +1,87 @@
+# 🔐 easySSP Authentication Python Client
+
+This module provides a simple and secure way to authenticate with the easySSP API using JWT tokens. It performs the
+initial login with username and password, requests the access and refresh tokens from the authentication endpoint,
+and renews the access token when it expires using the refresh token.
+
+---
+
+## 🚀 Features
+
+- 🔑 Retrieves JSON Web Tokens (JWTs) based on user credentials
+- 🗂️ Securely manages credentials and access/refresh tokens
+- ♻️ Automatically renews expired access tokens
+
+## 🔐 Access Requirements
+
+- Requires an easySSP **Pro** or **Process Edition** account
+
+---
+
+## 🛠️ How It Works
+
+1. **Create the `AuthClient` instance**  
+
+```python
+from easyssp_auth.authentication import AuthClient, AuthError
+
+try: 
+    auth_client = AuthClient("your_easyssp_username", "your_easyssp_password", "your-client-id")
+except AuthError as ex:
+    print(ex)
+```
+
+2. **Retrieve the access token**
+
+```python
+access_token = auth_client.get_access_token()
+```
+
+3. **Authenticate your requests**  
+You can use the retrieved access token in the `Authorization` header of your requests to authenticate with the easySSP API.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install easyssp-auth-client
+```
+
+Or clone and install from source:
+
+```bash
+git clone https://github.com/exxcellent/easyssp-auth-client-python.git
+cd easyssp-auth-client-python
+pip install -e .
+```
+
+---
+
+## 📁 Project Structure
+
+```bash
+easyssp_auth/
+├── __init__.py
+├── authentication.py      # Core logic for obtaining and storing the token
+```
+
+## 🛠️ Technical Requirements
+
+- Python 3.11+
+
+Install dependencies using uv:
+
+```bash
+pip install uv
+uv sync
+```
+
+## 🤝 Contributing
+
+This module is maintained as part of the easySSP ecosystem. If you find issues or want to suggest improvements, please
+open an issue or submit a pull request.
+
+## 📄 License
+
+This project is licensed under the MIT License.

README.md

@@ -0,0 +1,87 @@
+# 🔐 easySSP Authentication Python Client
+
+This module provides a simple and secure way to authenticate with the easySSP API using JWT tokens. It performs the
+initial login with username and password, requests the access and refresh tokens from the authentication endpoint,
+and renews the access token when it expires using the refresh token.
+
+---
+
+## 🚀 Features
+
+- 🔑 Retrieves JSON Web Tokens (JWTs) based on user credentials
+- 🗂️ Securely manages credentials and access/refresh tokens
+- ♻️ Automatically renews expired access tokens
+
+## 🔐 Access Requirements
+
+- Requires an easySSP **Pro** or **Process Edition** account
+
+---
+
+## 🛠️ How It Works
+
+1. **Create the `AuthClient` instance**  
+
+```python
+from easyssp_auth.authentication import AuthClient, AuthError
+
+try: 
+    auth_client = AuthClient("your_easyssp_username", "your_easyssp_password", "your-client-id")
+except AuthError as ex:
+    print(ex)
+```
+
+2. **Retrieve the access token**
+
+```python
+access_token = auth_client.get_access_token()
+```
+
+3. **Authenticate your requests**  
+You can use the retrieved access token in the `Authorization` header of your requests to authenticate with the easySSP API.
+
+---
+
+## 📦 Installation
+
+```bash
+pip install easyssp-auth-client
+```
+
+Or clone and install from source:
+
+```bash
+git clone https://github.com/exxcellent/easyssp-auth-client-python.git
+cd easyssp-auth-client-python
+pip install -e .
+```
+
+---
+
+## 📁 Project Structure
+
+```bash
+easyssp_auth/
+├── __init__.py
+├── authentication.py      # Core logic for obtaining and storing the token
+```
+
+## 🛠️ Technical Requirements
+
+- Python 3.11+
+
+Install dependencies using uv:
+
+```bash
+pip install uv
+uv sync
+```
+
+## 🤝 Contributing
+
+This module is maintained as part of the easySSP ecosystem. If you find issues or want to suggest improvements, please
+open an issue or submit a pull request.
+
+## 📄 License
+
+This project is licensed under the MIT License.

easyssp_auth/__init__.py

@@ -0,0 +1,3 @@
+__all__ = ["AuthClient", "AuthError"]
+
+from easyssp_auth.authentication import AuthClient, AuthError