axios-python 0.1.0__tar.gz

axios_python-0.1.0/.gitignore

@@ -0,0 +1,209 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+pre-commit-venv/

axios_python-0.1.0/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.4
+Name: axios-python
+Version: 0.1.0
+Summary: A developer-experience-first HTTP client for Python, inspired by Axios.
+Project-URL: Homepage, https://github.com/ashavijit/axios_python
+Project-URL: Repository, https://github.com/ashavijit/axios_python
+Author: Avijit
+License-Expression: MIT
+Keywords: async,axios,client,http,interceptors,middleware,retry
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# axios_python
+
+[![PyPI version](https://img.shields.io/pypi/v/axios_python.svg)](https://pypi.org/project/axios_python/)
+[![Python versions](https://img.shields.io/pypi/pyversions/axios_python.svg)](https://pypi.org/project/axios_python/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+A developer-experience-first HTTP client for Python, heavily inspired by [Axios](https://axios-http.com/).
+
+The Python ecosystem has amazing HTTP transport libraries (`requests`, `httpx`, `aiohttp`), but they are often focused purely on sending requests and getting responses. Modern applications need a **network orchestration layer**—features like request lifecycle hooks, middleware, interceptors, isolated client instances, request cancellation, and unified synchronous/asynchronous developer experience. 
+
+`axios_python` brings the elegant, feature-rich Axios model to Python, built natively on top of `httpx`.
+
+---
+
+## Features
+
+- 🌐 **Instance-based Client:** Completely isolated state for different APIs.
+- 🔄 **Unified API:** Identical interface for both Sync (`api.get()`) and Async (`await api.async_get()`).
+- 🔗 **Interceptors:** Hook into requests before they are sent, or responses before they are returned.
+- 🚰 **Middleware Pipeline:** Express.js-style async middleware for complex request wrapping.
+- 🔁 **Retry Engine:** Built-in strategies for linear, fixed, and exponential backoff.
+- 🚫 **Cancellation Tokens:** Cleanly abort requests gracefully.
+- 🔌 **Plugin System:** Easily extend clients with Cache, Auth, and Logging plugins (included out-of-the-box).
+- 🧩 **Swappable Transport:** Backed by `httpx` by default, but completely abstracted for custom transports.
+- 📝 **Fully Typed:** 100% strict typing support for modern Python 3.10+.
+
+---
+
+## Installation
+
+Install using `pip`:
+
+```bash
+pip install axios_python
+```
+
+Requires Python 3.10+.
+
+---
+
+## Quick Start
+
+### Basic Synchronous Usage
+
+```python
+import axios_python
+
+# Zero-setup module level request
+response = axios_python.get("https://httpbin.org/get", params={"query": "python"})
+
+# Or create an isolated instance with default configuration
+api = axios_python.create({
+    "base_url": "https://httpbin.org",
+    "timeout": 10,
+    "headers": {
+        "X-App-Client": "MyCLI/1.0"
+    }
+})
+
+# Make a request using the instance
+response = api.get("/get", params={"query": "python"})
+
+print(f"Status: {response.status_code}")
+if response.ok:
+    print(response.json())
+```
+
+### Asynchronous Native
+
+`axios_python` treats async as a first-class citizen. Just prefix method names with `async_`.
+
+```python
+import asyncio
+import axios_python
+
+async def fetch_data():
+    # Non-blocking async call via instance
+    api = axios_python.create({"base_url": "https://httpbin.org"})
+    response = await api.async_get("/delay/2")
+    
+    # Or module level
+    response = await axios_python.async_get("https://httpbin.org/delay/2")
+    print(response.data)
+
+asyncio.run(fetch_data())
+```
+
+### File Uploads
+
+Multipart file uploads are supported out of the box matching the `requests` interface.
+
+```python
+with open("report.csv", "rb") as f:
+    # Files can be passed as an open file handle or a tuple mapping
+    files = {"file": ("report.csv", f, "text/csv")}
+    response = axios_python.post("https://httpbin.org/post", files=files)
+```
+
+### Streaming Responses
+
+For large files or continuous data streams, use `stream=True`. The response is exposed as a context manager for both sync and async calls.
+
+```python
+import axios_python
+
+# Synchronous execution
+with axios_python.get("https://httpbin.org/stream-bytes/100", stream=True) as response:
+    for chunk in response.iter_bytes(chunk_size=10):
+        print(len(chunk))
+
+# Asynchronous execution in an async function
+async with await axios_python.async_get("https://.../stream", stream=True) as response:
+    async for line in response.aiter_lines():
+        print(line)
+```
+
+---
+
+## Core Concepts
+
+### Interceptors
+
+Interceptors allow you to tap into the lifecycle of a request or response. They run sequentially.
+
+```python
+api = axios_python.create({"base_url": "https://api.myapp.com"})
+
+# Add a request interceptor
+def authorize_request(config):
+    config["headers"]["Authorization"] = "Bearer token123"
+    return config
+
+api.interceptors.request.use(authorize_request)
+
+# Add a response interceptor
+def unwrap_data(response):
+    # Automatically unwrap the 'data' payload from the JSON
+    response.data = response.json().get("data", response.data)
+    return response
+
+api.interceptors.response.use(unwrap_data)
+```
+
+### Middleware
+
+For more complex logic that needs to "wrap" the entire request (like timing, distributed tracing, or custom caching), use the Express.js-style middleware pipeline.
+
+```python
+import time
+
+async def logger_middleware(ctx, next_fn):
+    print(f"Starting {ctx.get('method')} to {ctx.get('url')}")
+    start = time.monotonic()
+    
+    # Yield control to the next middleware / transport layer
+    result = await next_fn(ctx)
+    
+    elapsed = time.monotonic() - start
+    print(f"Finished in {elapsed:.3f}s with status {result.status_code}")
+    
+    return result
+
+api.use(logger_middleware)
+```
+
+### Retry Engine
+
+Temporary network issues shouldn't hard-crash your app. Provide a retry strategy when creating your client.
+
+```python
+from axios_python import ExponentialBackoff
+
+api = axios_python.create({
+    "base_url": "https://httpbin.org",
+    "max_retries": 3,
+    "retry_strategy": ExponentialBackoff(base=1.0, multiplier=2.0, max_delay=10.0),
+})
+```
+
+By default, this retries on Network Errors and Timeouts.
+
+### Request Cancellation
+
+Use a `CancelToken` to abort long-running requests or cancel requests when a user navigates away.
+
+```python
+from axios_python import CancelToken
+import threading
+import time
+
+token = CancelToken()
+
+def background_fetch():
+    try:
+        api.get("/delay/10", cancel_token=token)
+    except axios_python.CancelError as e:
+        print(f"Request aborted: {e}")
+
+threading.Thread(target=background_fetch).start()
+
+time.sleep(1)
+token.cancel(reason="User clicked 'Stop'")
+```
+
+---
+
+## Plugins
+
+`axios_python` ships with first-party plugins for common use-cases.
+
+### Authentication Plugin
+
+Automatically injects `Authorization` headers. Supports static tokens or dynamic providers.
+
+```python
+from axios_python import AuthPlugin
+
+api.plugin(AuthPlugin(scheme="Bearer", token="super-secret-key"))
+
+# Or dynamically fetch it:
+# api.plugin(AuthPlugin(token_provider=lambda: get_fresh_token()))
+```
+
+### Cache Plugin
+
+In-memory TTL cache for `GET` requests to reduce redundant network load.
+
+```python
+from axios_python import CachePlugin
+
+# Cache GET responses for 120 seconds, max 256 items
+api.plugin(CachePlugin(ttl=120, max_size=256))
+```
+
+### Logger Plugin
+
+Standardized `logging` for requests and responses out of the box.
+
+```python
+import logging
+from axios_python import LoggerPlugin
+
+logging.basicConfig(level=logging.INFO)
+api.plugin(LoggerPlugin(level=logging.INFO))
+```
+
+---
+
+## Configuration Reference
+
+You can pass the following properties to `axios_python.create(config)` or as overrides to individual request methods (`api.get("/url", **kwargs)`):
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `base_url` | `str` | Base URL attached to relative paths. |
+| `method` | `str` | HTTP Method (e.g., `"GET"`, `"POST"`). |
+| `url` | `str` | The target path or absolute URL. |
+| `headers` | `dict` | Dictionary of HTTP headers. |
+| `params` | `dict` | URL Query parameters. |
+| `data` | `Any` | Request body content (raw). |
+| `json` | `Any` | Request body content (automatically serialized to JSON). |
+| `files` | `Any` | Multipart-encoded files dictionary. |
+| `stream` | `bool` | Stream the response (Default: False). |
+| `timeout` | `float` | Max seconds to wait for a response (Default: 30). |
+| `max_retries` | `int` | Maximum retry attempts on failure (Default: 0). |
+| `retry_strategy` | `RetryStrategy` | Backoff class instance (e.g., `ExponentialBackoff`). |
+| `cancel_token` | `CancelToken` | Token to cancel the request mid-flight. |
+
+---
+
+## Error Handling
+
+`axios_python` provides strongly typed exceptions extending from `AxiosPythonError`. The `Response` object provides a `.raise_for_status()` method exactly like `requests`.
+
+```python
+import axios_python
+
+try:
+    response = axios_python.get("https://httpbin.org/status/404")
+    response.raise_for_status()
+except axios_python.HTTPStatusError as e:
+    print(f"Request failed with status code {e.response.status_code}")
+except axios_python.TimeoutError:
+    print("Request timed out.")
+except axios_python.NetworkError:
+    print("Unable to connect to the server.")
+except axios_python.RetryError:
+    print("All retry attempts failed.")
+except axios_python.CancelError:
+    print("Request was manually cancelled.")
+except axios_python.AxiosPythonError as e:
+    print(f"A general axios_python error occurred: {e}")
+```
+
+---
+
+## Advanced
+
+### Custom Transports
+
+You aren't locked into `httpx`. You can build a custom transport adapter by implementing the `BaseTransport` abstract class.
+
+```python
+from axios_python import AxiosPython, BaseTransport
+
+class MockTransport(BaseTransport):
+    def send(self, request):
+        return axios_python.Response(200, {}, {"mock": "data"}, request)
+
+    async def send_async(self, request):
+        return self.send(request)
+
+# Pass the custom transport directly to the AxiosPython constructor
+api = AxiosPython(config={"base_url": "mock://"}, transport=MockTransport())
+```
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).