rxresume-python 0.1.0__tar.gz

rxresume_python-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ata Can Yaymacı
+
+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.

rxresume_python-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: rxresume-python
+Version: 0.1.0
+Summary: Unofficial Python API client (SDK) for Reactive Resume v4
+Author: Ata Can Yaymacı
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic[email]>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.20.0; extra == "dev"
+Requires-Dist: respx>=0.20.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: bandit>=1.7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# Reactive Resume Python SDK (`rxresume-python`)
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Pydantic v2](https://img.shields.io/badge/pydantic-v2-red.svg)](https://docs.pydantic.dev/)
+[![HTTPX](https://img.shields.io/badge/http--client-httpx-brightgreen.svg)](https://www.python-httpx.org/)
+
+An unofficial modern, type-safe Python API Client (SDK) for **Reactive Resume v4**.
+
+It supports both synchronous (`httpx.Client`) and asynchronous (`httpx.AsyncClient`) clients, ensures fully typed request/response schemas using **Pydantic v2**, and maps API errors to clean, descriptive Python exceptions.
+
+---
+
+## Features
+
+- **Dual client modes**: Support for both sync and async APIs.
+- **Type safety**: Fully typed models for Resumes, Sections, Basics, and Users using Pydantic V2.
+- **Robust error handling**: Raw API status errors are automatically parsed into specific exceptions (`AuthenticationError`, `NotFoundError`, etc.).
+- **Developer Experience (DX)**: Code-completion ready with clear typing and docstrings.
+
+---
+
+## Installation
+
+Install the package via `pip` or your favorite package manager:
+
+```bash
+pip install rxresume-python
+```
+
+---
+
+## Quick Start
+
+### 1. Asynchronous Client (FastAPI / Asynchronous Code)
+
+```python
+import asyncio
+from reactive_resume import AsyncRxResumeClient
+from reactive_resume.models import ResumeImportData, Basics
+
+async def main():
+    # Initialize the async client
+    async with AsyncRxResumeClient(base_url="https://rxresu.me", api_key="your_api_key") as client:
+        # Create a new resume
+        import_data = ResumeImportData(
+            title="Ata Can Yaymacı - Backend Engineer",
+            basics=Basics(
+                name="Ata Can Yaymacı",
+                headline="Backend Engineer",
+                email="ata@example.com",
+                phone="+905555555555",
+                website="https://example.com"
+            ),
+            sections={}
+        )
+
+        try:
+            # Import/Create a new resume
+            new_resume = await client.resumes.import_resume(import_data)
+            print(f"Created resume: {new_resume.name} (ID: {new_resume.id})")
+
+            # Fetch the generated PDF URL
+            pdf_url = await client.resumes.get_pdf_url(new_resume.id)
+            print(f"PDF URL: {pdf_url}")
+
+        except Exception as e:
+            print(f"An error occurred: {e}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### 2. Synchronous Client
+
+```python
+from reactive_resume import RxResumeClient
+from reactive_resume.models import ResumeImportData
+
+with RxResumeClient(base_url="https://rxresu.me", api_key="your_api_key") as client:
+    resumes = client.resumes.list()
+    for resume in resumes:
+        print(f"Resume: {resume.name} (Slug: {resume.slug})")
+```
+
+---
+
+## Error Handling
+
+All client API calls map HTTP errors to specific exception classes:
+
+```python
+from reactive_resume import RxResumeClient, AuthenticationError, NotFoundError
+
+try:
+    with RxResumeClient(base_url="https://rxresu.me", api_key="wrong_key") as client:
+        client.resumes.list()
+except AuthenticationError as e:
+    print(f"Auth error (Status {e.status_code}): {e}")
+except NotFoundError as e:
+    print(f"Not found: {e}")
+except Exception as e:
+    print(f"Generic error: {e}")
+```
+
+---
+
+## Development & Testing
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/reactive-resume-api-client-py.git
+   cd reactive-resume-api-client-py
+   ```
+
+2. Install dependencies:
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   pip install -e ".[dev]"
+   ```
+
+3. Run the tests:
+   ```bash
+   pytest
+   ```
+
+---
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

rxresume_python-0.1.0/README.md

@@ -0,0 +1,131 @@
+# Reactive Resume Python SDK (`rxresume-python`)
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Pydantic v2](https://img.shields.io/badge/pydantic-v2-red.svg)](https://docs.pydantic.dev/)
+[![HTTPX](https://img.shields.io/badge/http--client-httpx-brightgreen.svg)](https://www.python-httpx.org/)
+
+An unofficial modern, type-safe Python API Client (SDK) for **Reactive Resume v4**.
+
+It supports both synchronous (`httpx.Client`) and asynchronous (`httpx.AsyncClient`) clients, ensures fully typed request/response schemas using **Pydantic v2**, and maps API errors to clean, descriptive Python exceptions.
+
+---
+
+## Features
+
+- **Dual client modes**: Support for both sync and async APIs.
+- **Type safety**: Fully typed models for Resumes, Sections, Basics, and Users using Pydantic V2.
+- **Robust error handling**: Raw API status errors are automatically parsed into specific exceptions (`AuthenticationError`, `NotFoundError`, etc.).
+- **Developer Experience (DX)**: Code-completion ready with clear typing and docstrings.
+
+---
+
+## Installation
+
+Install the package via `pip` or your favorite package manager:
+
+```bash
+pip install rxresume-python
+```
+
+---
+
+## Quick Start
+
+### 1. Asynchronous Client (FastAPI / Asynchronous Code)
+
+```python
+import asyncio
+from reactive_resume import AsyncRxResumeClient
+from reactive_resume.models import ResumeImportData, Basics
+
+async def main():
+    # Initialize the async client
+    async with AsyncRxResumeClient(base_url="https://rxresu.me", api_key="your_api_key") as client:
+        # Create a new resume
+        import_data = ResumeImportData(
+            title="Ata Can Yaymacı - Backend Engineer",
+            basics=Basics(
+                name="Ata Can Yaymacı",
+                headline="Backend Engineer",
+                email="ata@example.com",
+                phone="+905555555555",
+                website="https://example.com"
+            ),
+            sections={}
+        )
+
+        try:
+            # Import/Create a new resume
+            new_resume = await client.resumes.import_resume(import_data)
+            print(f"Created resume: {new_resume.name} (ID: {new_resume.id})")
+
+            # Fetch the generated PDF URL
+            pdf_url = await client.resumes.get_pdf_url(new_resume.id)
+            print(f"PDF URL: {pdf_url}")
+
+        except Exception as e:
+            print(f"An error occurred: {e}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### 2. Synchronous Client
+
+```python
+from reactive_resume import RxResumeClient
+from reactive_resume.models import ResumeImportData
+
+with RxResumeClient(base_url="https://rxresu.me", api_key="your_api_key") as client:
+    resumes = client.resumes.list()
+    for resume in resumes:
+        print(f"Resume: {resume.name} (Slug: {resume.slug})")
+```
+
+---
+
+## Error Handling
+
+All client API calls map HTTP errors to specific exception classes:
+
+```python
+from reactive_resume import RxResumeClient, AuthenticationError, NotFoundError
+
+try:
+    with RxResumeClient(base_url="https://rxresu.me", api_key="wrong_key") as client:
+        client.resumes.list()
+except AuthenticationError as e:
+    print(f"Auth error (Status {e.status_code}): {e}")
+except NotFoundError as e:
+    print(f"Not found: {e}")
+except Exception as e:
+    print(f"Generic error: {e}")
+```
+
+---
+
+## Development & Testing
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/reactive-resume-api-client-py.git
+   cd reactive-resume-api-client-py
+   ```
+
+2. Install dependencies:
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   pip install -e ".[dev]"
+   ```
+
+3. Run the tests:
+   ```bash
+   pytest
+   ```
+
+---
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

rxresume_python-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rxresume-python"
+version = "0.1.0"
+description = "Unofficial Python API client (SDK) for Reactive Resume v4"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Ata Can Yaymacı"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic[email]>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.20.0",
+    "respx>=0.20.0",
+    "ruff>=0.1.0",
+    "pre-commit>=3.0.0",
+    "bandit>=1.7.0",
+    "pytest-cov>=4.0.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["reactive_resume*"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

rxresume_python-0.1.0/reactive_resume/__init__.py

@@ -0,0 +1,26 @@
+"""Reactive Resume API Python SDK.
+
+An unofficial client for programmatically interacting with Reactive Resume v4 API.
+"""
+
+from .core.client import RxResumeClient
+from .core.async_client import AsyncRxResumeClient
+from .core.exceptions import (
+    ReactiveResumeError,
+    ReactiveResumeAPIError,
+    AuthenticationError,
+    NotFoundError,
+    ValidationError,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "RxResumeClient",
+    "AsyncRxResumeClient",
+    "ReactiveResumeError",
+    "ReactiveResumeAPIError",
+    "AuthenticationError",
+    "NotFoundError",
+    "ValidationError",
+]

rxresume_python-0.1.0/reactive_resume/api/__init__.py

@@ -0,0 +1,11 @@
+"""API endpoints and service groups."""
+
+from .auth import AuthAPI, AsyncAuthAPI
+from .resumes import ResumesAPI, AsyncResumesAPI
+
+__all__ = [
+    "AuthAPI",
+    "AsyncAuthAPI",
+    "ResumesAPI",
+    "AsyncResumesAPI",
+]

rxresume_python-0.1.0/reactive_resume/api/auth.py

@@ -0,0 +1,66 @@
+"""Authentication endpoints implementation."""
+
+from typing import Tuple
+from ..models.user import User
+
+
+class AuthAPI:
+    """Synchronous Authentication operations."""
+
+    def __init__(self, client) -> None:
+        self._client = client
+
+    def login(self, email: str, password: str) -> Tuple[str, User]:
+        """Log in with email and password.
+
+        Args:
+            email: User's email.
+            password: User's password.
+
+        Returns:
+            A tuple of (access_token, User object).
+        """
+        payload = {"identifier": email, "password": password}
+        response = self._client._request("POST", "/api/auth/login", json=payload)
+
+        # Typically returns token in cookies or response body
+        # Let's extract token and user
+        token = response.get("token") or response.get("accessToken", "")
+        user_data = response.get("user") or response
+        user = User.model_validate(user_data)
+        return token, user
+
+    def me(self) -> User:
+        """Get the current authenticated user profile."""
+        response = self._client._request("GET", "/api/user/me")
+        return User.model_validate(response)
+
+
+class AsyncAuthAPI:
+    """Asynchronous Authentication operations."""
+
+    def __init__(self, client) -> None:
+        self._client = client
+
+    async def login(self, email: str, password: str) -> Tuple[str, User]:
+        """Log in asynchronously with email and password.
+
+        Args:
+            email: User's email.
+            password: User's password.
+
+        Returns:
+            A tuple of (access_token, User object).
+        """
+        payload = {"identifier": email, "password": password}
+        response = await self._client._request("POST", "/api/auth/login", json=payload)
+
+        token = response.get("token") or response.get("accessToken", "")
+        user_data = response.get("user") or response
+        user = User.model_validate(user_data)
+        return token, user
+
+    async def me(self) -> User:
+        """Get the current authenticated user profile asynchronously."""
+        response = await self._client._request("GET", "/api/user/me")
+        return User.model_validate(response)

rxresume_python-0.1.0/reactive_resume/api/resumes.py

@@ -0,0 +1,169 @@
+"""Resumes endpoints implementation."""
+
+from typing import List, Dict, Any
+from ..models.resume import Resume, ResumeImportData
+
+
+class ResumesAPI:
+    """Synchronous Resume operations."""
+
+    def __init__(self, client) -> None:
+        self._client = client
+
+    def list(self) -> List[Resume]:
+        """List all resumes for the authenticated user.
+
+        Returns:
+            A list of Resume objects.
+        """
+        response = self._client._request("GET", "/api/openapi/resumes")
+        # The response is usually a list of resume objects
+        if isinstance(response, dict) and "data" in response:
+            # Handle potential pagination wrapper
+            items = response["data"]
+        else:
+            items = response
+        return [Resume.model_validate(item) for item in items]
+
+    def get(self, resume_id: str) -> Resume:
+        """Retrieve a specific resume by ID.
+
+        Args:
+            resume_id: Unique identifier for the resume.
+
+        Returns:
+            The Resume object.
+        """
+        response = self._client._request("GET", f"/api/openapi/resume/{resume_id}")
+        return Resume.model_validate(response)
+
+    def create(self, data: ResumeImportData) -> Resume:
+        """Create or import a new resume.
+
+        Args:
+            data: ResumeImportData object containing title, basics, and sections.
+
+        Returns:
+            The created Resume object.
+        """
+        # Convert Pydantic model to dict, matching what API expects
+        payload = data.model_dump(by_alias=True, exclude_none=True)
+        response = self._client._request("POST", "/api/openapi/resumes", json=payload)
+        return Resume.model_validate(response)
+
+    def import_resume(self, data: ResumeImportData) -> Resume:
+        """Alias for create, importing a resume.
+
+        Args:
+            data: ResumeImportData object containing title, basics, and sections.
+
+        Returns:
+            The imported Resume object.
+        """
+        return self.create(data)
+
+    def update(self, resume_id: str, data: Dict[str, Any]) -> Resume:
+        """Update a resume (PATCH).
+
+        Args:
+            resume_id: Unique identifier for the resume.
+            data: Dictionary of properties to update (e.g. JSON Patch or key-value updates).
+
+        Returns:
+            The updated Resume object.
+        """
+        # Reactive Resume v4 supports PATCH with JSON Patch or direct body updates
+        response = self._client._request("PATCH", f"/api/openapi/resume/{resume_id}", json=data)
+        return Resume.model_validate(response)
+
+    def delete(self, resume_id: str) -> None:
+        """Delete a resume by ID.
+
+        Args:
+            resume_id: Unique identifier for the resume.
+        """
+        self._client._request("DELETE", f"/api/openapi/resume/{resume_id}")
+
+    def get_pdf_url(self, resume_id: str) -> str:
+        """Get the URL to download the PDF for a specific resume.
+
+        Args:
+            resume_id: Unique identifier for the resume.
+
+        Returns:
+            The absolute PDF download URL.
+        """
+        # The print/pdf download URL format in Reactive Resume V4 API
+        # Typically of form: {base_url}/api/openapi/resume/{resume_id}/pdf
+        return f"{self._client.base_url}/api/openapi/resume/{resume_id}/pdf"
+
+
+class AsyncResumesAPI:
+    """Asynchronous Resume operations."""
+
+    def __init__(self, client) -> None:
+        self._client = client
+
+    async def list(self) -> List[Resume]:
+        """List all resumes asynchronously.
+
+        Returns:
+            A list of Resume objects.
+        """
+        response = await self._client._request("GET", "/api/openapi/resumes")
+        if isinstance(response, dict) and "data" in response:
+            items = response["data"]
+        else:
+            items = response
+        return [Resume.model_validate(item) for item in items]
+
+    async def get(self, resume_id: str) -> Resume:
+        """Retrieve a specific resume asynchronously.
+
+        Args:
+            resume_id: Unique identifier for the resume.
+
+        Returns:
+            The Resume object.
+        """
+        response = await self._client._request("GET", f"/api/openapi/resume/{resume_id}")
+        return Resume.model_validate(response)
+
+    async def create(self, data: ResumeImportData) -> Resume:
+        """Create or import a new resume asynchronously.
+
+        Args:
+            data: ResumeImportData object.
+
+        Returns:
+            The created Resume object.
+        """
+        payload = data.model_dump(by_alias=True, exclude_none=True)
+        response = await self._client._request("POST", "/api/openapi/resumes", json=payload)
+        return Resume.model_validate(response)
+
+    async def import_resume(self, data: ResumeImportData) -> Resume:
+        """Alias for create, importing a resume asynchronously."""
+        return await self.create(data)
+
+    async def update(self, resume_id: str, data: Dict[str, Any]) -> Resume:
+        """Update a resume asynchronously."""
+        response = await self._client._request(
+            "PATCH", f"/api/openapi/resume/{resume_id}", json=data
+        )
+        return Resume.model_validate(response)
+
+    async def delete(self, resume_id: str) -> None:
+        """Delete a resume asynchronously."""
+        await self._client._request("DELETE", f"/api/openapi/resume/{resume_id}")
+
+    async def get_pdf_url(self, resume_id: str) -> str:
+        """Get the URL to download the PDF asynchronously.
+
+        Args:
+            resume_id: Unique identifier for the resume.
+
+        Returns:
+            The absolute PDF download URL.
+        """
+        return f"{self._client.base_url}/api/openapi/resume/{resume_id}/pdf"

rxresume_python-0.1.0/reactive_resume/core/__init__.py

@@ -0,0 +1,17 @@
+"""Core functionality and HTTP client structures."""
+
+from .exceptions import (
+    ReactiveResumeError,
+    ReactiveResumeAPIError,
+    AuthenticationError,
+    NotFoundError,
+    ValidationError,
+)
+
+__all__ = [
+    "ReactiveResumeError",
+    "ReactiveResumeAPIError",
+    "AuthenticationError",
+    "NotFoundError",
+    "ValidationError",
+]