vortex-python-sdk 0.0.1__tar.gz

vortex_python_sdk-0.0.1/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2024-10-10
+
+### Added
+- Initial release of Vortex Python SDK
+- JWT generation with HMAC-SHA256 signing
+- Complete invitation management API
+- Async and sync HTTP client methods
+- Type safety with Pydantic models
+- Context manager support for resource cleanup
+- Comprehensive error handling with VortexApiError
+- Full compatibility with Node.js SDK API
+
+### Features
+- `generate_jwt()` - Generate Vortex JWT tokens
+- `get_invitations_by_target()` - Get invitations by email/username/phone
+- `accept_invitations()` - Accept multiple invitations
+- `get_invitation()` - Get specific invitation by ID
+- `revoke_invitation()` - Revoke invitation
+- `get_invitations_by_group()` - Get invitations for a group
+- `delete_invitations_by_group()` - Delete all group invitations
+- `reinvite()` - Reinvite functionality
+- Both async and sync versions of all methods
+- Python 3.8+ support

vortex_python_sdk-0.0.1/LICENSE

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

vortex_python_sdk-0.0.1/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+recursive-include src/vortex_sdk *.py
+recursive-include src/vortex_sdk py.typed
+exclude tests/
+exclude .github/
+exclude *.pyc
+exclude __pycache__/

vortex_python_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: vortex-python-sdk
+Version: 0.0.1
+Summary: Vortex Python SDK for invitation management and JWT generation
+Author-email: TeamVortexSoftware <support@vortexsoftware.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/teamvortexsoftware/vortex-python-sdk
+Project-URL: Repository, https://github.com/teamvortexsoftware/vortex-python-sdk.git
+Project-URL: Documentation, https://docs.vortexsoftware.com/python-sdk
+Project-URL: Changelog, https://github.com/teamvortexsoftware/vortex-python-sdk/blob/main/CHANGELOG.md
+Keywords: vortex,invitations,jwt,api,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.8.0
+Requires-Dist: typing-extensions>=4.8.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Vortex Python SDK
+
+A Python SDK for Vortex invitation management and JWT generation.
+
+## Installation
+
+```bash
+pip install vortex-python-sdk
+```
+
+> **Note**: The package will be available on PyPI once published. See [PUBLISHING.md](PUBLISHING.md) for publishing instructions.
+
+## Usage
+
+### Basic Setup
+
+```python
+from vortex_sdk import Vortex
+
+# Initialize the client
+vortex = Vortex(api_key="your-api-key")
+
+# Or with custom base URL
+vortex = Vortex(api_key="your-api-key", base_url="https://custom-api.example.com")
+```
+
+### JWT Generation
+
+```python
+# Generate JWT for a user
+jwt = vortex.generate_jwt({
+    "user_id": "user123",
+    "identifiers": {
+        "email": "user@example.com",
+        "username": "johndoe"
+    },
+    "groups": ["admin", "users"],
+    "role": "admin"
+})
+
+print(f"JWT: {jwt}")
+```
+
+### Invitation Management
+
+#### Get Invitations by Target
+
+```python
+import asyncio
+
+async def get_user_invitations():
+    # Async version
+    invitations = await vortex.get_invitations_by_target("email", "user@example.com")
+    for invitation in invitations:
+        print(f"Invitation ID: {invitation.id}, Status: {invitation.status}")
+
+# Sync version
+invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
+```
+
+#### Accept Invitations
+
+```python
+async def accept_user_invitations():
+    # Async version
+    result = await vortex.accept_invitations(
+        invitation_ids=["inv1", "inv2"],
+        target={"type": "email", "value": "user@example.com"}
+    )
+    print(f"Result: {result}")
+
+# Sync version
+result = vortex.accept_invitations_sync(
+    invitation_ids=["inv1", "inv2"],
+    target={"type": "email", "value": "user@example.com"}
+)
+```
+
+#### Get Specific Invitation
+
+```python
+async def get_invitation():
+    # Async version
+    invitation = await vortex.get_invitation("invitation-id")
+    print(f"Invitation: {invitation.id}")
+
+# Sync version
+invitation = vortex.get_invitation_sync("invitation-id")
+```
+
+#### Revoke Invitation
+
+```python
+async def revoke_invitation():
+    # Async version
+    result = await vortex.revoke_invitation("invitation-id")
+    print(f"Revoked: {result}")
+
+# Sync version
+result = vortex.revoke_invitation_sync("invitation-id")
+```
+
+### Group Operations
+
+#### Get Invitations by Group
+
+```python
+async def get_group_invitations():
+    # Async version
+    invitations = await vortex.get_invitations_by_group("organization", "org123")
+    print(f"Found {len(invitations)} invitations")
+
+# Sync version
+invitations = vortex.get_invitations_by_group_sync("organization", "org123")
+```
+
+#### Delete Invitations by Group
+
+```python
+async def delete_group_invitations():
+    # Async version
+    result = await vortex.delete_invitations_by_group("organization", "org123")
+    print(f"Deleted: {result}")
+
+# Sync version
+result = vortex.delete_invitations_by_group_sync("organization", "org123")
+```
+
+#### Reinvite
+
+```python
+async def reinvite_user():
+    # Async version
+    invitation = await vortex.reinvite("invitation-id")
+    print(f"Reinvited: {invitation.id}")
+
+# Sync version
+invitation = vortex.reinvite_sync("invitation-id")
+```
+
+### Context Manager Usage
+
+```python
+# Async context manager
+async with Vortex(api_key="your-api-key") as vortex:
+    invitations = await vortex.get_invitations_by_target("email", "user@example.com")
+
+# Sync context manager
+with Vortex(api_key="your-api-key") as vortex:
+    invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
+```
+
+### Error Handling
+
+```python
+from vortex_sdk import VortexApiError
+
+try:
+    invitation = vortex.get_invitation_sync("invalid-id")
+except VortexApiError as e:
+    print(f"API Error: {e.message} (Status: {e.status_code})")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+## Development
+
+### Installation
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+```bash
+# Format code
+black src/ tests/
+isort src/ tests/
+
+# Lint code
+ruff check src/ tests/
+mypy src/
+```
+
+## License
+
+MIT

vortex_python_sdk-0.0.1/README.md

@@ -0,0 +1,195 @@
+# Vortex Python SDK
+
+A Python SDK for Vortex invitation management and JWT generation.
+
+## Installation
+
+```bash
+pip install vortex-python-sdk
+```
+
+> **Note**: The package will be available on PyPI once published. See [PUBLISHING.md](PUBLISHING.md) for publishing instructions.
+
+## Usage
+
+### Basic Setup
+
+```python
+from vortex_sdk import Vortex
+
+# Initialize the client
+vortex = Vortex(api_key="your-api-key")
+
+# Or with custom base URL
+vortex = Vortex(api_key="your-api-key", base_url="https://custom-api.example.com")
+```
+
+### JWT Generation
+
+```python
+# Generate JWT for a user
+jwt = vortex.generate_jwt({
+    "user_id": "user123",
+    "identifiers": {
+        "email": "user@example.com",
+        "username": "johndoe"
+    },
+    "groups": ["admin", "users"],
+    "role": "admin"
+})
+
+print(f"JWT: {jwt}")
+```
+
+### Invitation Management
+
+#### Get Invitations by Target
+
+```python
+import asyncio
+
+async def get_user_invitations():
+    # Async version
+    invitations = await vortex.get_invitations_by_target("email", "user@example.com")
+    for invitation in invitations:
+        print(f"Invitation ID: {invitation.id}, Status: {invitation.status}")
+
+# Sync version
+invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
+```
+
+#### Accept Invitations
+
+```python
+async def accept_user_invitations():
+    # Async version
+    result = await vortex.accept_invitations(
+        invitation_ids=["inv1", "inv2"],
+        target={"type": "email", "value": "user@example.com"}
+    )
+    print(f"Result: {result}")
+
+# Sync version
+result = vortex.accept_invitations_sync(
+    invitation_ids=["inv1", "inv2"],
+    target={"type": "email", "value": "user@example.com"}
+)
+```
+
+#### Get Specific Invitation
+
+```python
+async def get_invitation():
+    # Async version
+    invitation = await vortex.get_invitation("invitation-id")
+    print(f"Invitation: {invitation.id}")
+
+# Sync version
+invitation = vortex.get_invitation_sync("invitation-id")
+```
+
+#### Revoke Invitation
+
+```python
+async def revoke_invitation():
+    # Async version
+    result = await vortex.revoke_invitation("invitation-id")
+    print(f"Revoked: {result}")
+
+# Sync version
+result = vortex.revoke_invitation_sync("invitation-id")
+```
+
+### Group Operations
+
+#### Get Invitations by Group
+
+```python
+async def get_group_invitations():
+    # Async version
+    invitations = await vortex.get_invitations_by_group("organization", "org123")
+    print(f"Found {len(invitations)} invitations")
+
+# Sync version
+invitations = vortex.get_invitations_by_group_sync("organization", "org123")
+```
+
+#### Delete Invitations by Group
+
+```python
+async def delete_group_invitations():
+    # Async version
+    result = await vortex.delete_invitations_by_group("organization", "org123")
+    print(f"Deleted: {result}")
+
+# Sync version
+result = vortex.delete_invitations_by_group_sync("organization", "org123")
+```
+
+#### Reinvite
+
+```python
+async def reinvite_user():
+    # Async version
+    invitation = await vortex.reinvite("invitation-id")
+    print(f"Reinvited: {invitation.id}")
+
+# Sync version
+invitation = vortex.reinvite_sync("invitation-id")
+```
+
+### Context Manager Usage
+
+```python
+# Async context manager
+async with Vortex(api_key="your-api-key") as vortex:
+    invitations = await vortex.get_invitations_by_target("email", "user@example.com")
+
+# Sync context manager
+with Vortex(api_key="your-api-key") as vortex:
+    invitations = vortex.get_invitations_by_target_sync("email", "user@example.com")
+```
+
+### Error Handling
+
+```python
+from vortex_sdk import VortexApiError
+
+try:
+    invitation = vortex.get_invitation_sync("invalid-id")
+except VortexApiError as e:
+    print(f"API Error: {e.message} (Status: {e.status_code})")
+except Exception as e:
+    print(f"Unexpected error: {e}")
+```
+
+## Development
+
+### Installation
+
+```bash
+# Install development dependencies
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Code Formatting
+
+```bash
+# Format code
+black src/ tests/
+isort src/ tests/
+
+# Lint code
+ruff check src/ tests/
+mypy src/
+```
+
+## License
+
+MIT

vortex_python_sdk-0.0.1/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "vortex-python-sdk"
+version = "0.0.1"
+description = "Vortex Python SDK for invitation management and JWT generation"
+authors = [{name = "TeamVortexSoftware", email = "support@vortexsoftware.com"}]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = ["vortex", "invitations", "jwt", "api", "sdk"]
+
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic>=2.8.0",
+    "typing-extensions>=4.8.0"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=4.0.0",
+    "black>=23.0.0",
+    "isort>=5.12.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0"
+]
+
+[project.urls]
+Homepage = "https://github.com/teamvortexsoftware/vortex-python-sdk"
+Repository = "https://github.com/teamvortexsoftware/vortex-python-sdk.git"
+Documentation = "https://docs.vortexsoftware.com/python-sdk"
+Changelog = "https://github.com/teamvortexsoftware/vortex-python-sdk/blob/main/CHANGELOG.md"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+vortex_sdk = ["py.typed"]
+
+[tool.setuptools.dynamic]
+
+[tool.black]
+line-length = 88
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+
+[tool.isort]
+profile = "black"
+line_length = 88
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+warn_unreachable = true
+
+[tool.ruff]
+target-version = "py38"
+line-length = 88
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "B",  # flake8-bugbear
+    "C4", # flake8-comprehensions
+    "UP", # pyupgrade
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short --strict-markers"
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "integration: marks tests as integration tests"
+]

vortex_python_sdk-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+