django-requests-api 0.6.2__tar.gz → 0.6.6__tar.gz

{django_requests_api-0.6.2 → django_requests_api-0.6.6}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v6.0.0
   hooks:
   - id: check-added-large-files
   - id: check-case-conflict
@@ -11,37 +11,42 @@ repos:
   - id: end-of-file-fixer
   - id: trailing-whitespace
 - repo: https://github.com/asottile/pyupgrade
-  rev: v3.7.0
+  rev: v3.21.2
   hooks:
   - id: pyupgrade
     args: [--py36-plus]
-- repo: https://github.com/psf/black
-  rev: 23.3.0
+- repo: https://github.com/psf/black-pre-commit-mirror
+  rev: 26.3.1
   hooks:
   - id: black
 - repo: https://github.com/asottile/blacken-docs
-  rev: 1.14.0
+  rev: 1.20.0
   hooks:
   - id: blacken-docs
     additional_dependencies:
     - black>=22.12.0
 - repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+  rev: 8.0.1
   hooks:
   - id: isort
     args: ["--profile", "black"]
 - repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
+  rev: 7.3.0
   hooks:
   - id: flake8
     additional_dependencies:
+    - flake8-pyproject
     - flake8-bugbear
     - flake8-comprehensions
     - flake8-tidy-imports
     - flake8-typing-imports
 - repo: https://github.com/mgedmin/check-manifest
-  rev: "0.49"
+  rev: "0.51"
   hooks:
   - id: check-manifest
     args: [--no-build-isolation]
-    additional_dependencies: ["Django>=3.2"]
+    additional_dependencies:
+      - Django>=3.2
+      - build
+      - setuptools>=77
+      - wheel

django_requests_api-0.6.6/CHANGELOG.rst

@@ -0,0 +1,17 @@
+requests_api 0.6.6 (2026-08-13)
+===============================
+
+No significant changes.
+
+
+requests_api 0.6.5 (2026-08-10)
+===============================
+
+No significant changes.
+
+
+requests_api 0.2.0-dev (2023-06-23)
+====================================
+
+
+No significant changes.

{django_requests_api-0.6.2 → django_requests_api-0.6.6}/CODEOWNERS

@@ -1,2 +1,2 @@
 # Require review from Code Owners
-* @dlrsp-dev
+* @dlrsp-dev @dlrsp-actions[bot]

django_requests_api-0.6.6/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: django-requests-api
+Version: 0.6.6
+Summary: Django application providing a thin requests.Session wrapper with a base URL and small HTTP helpers.
+Author-email: DLRSP <dlrsp.dev@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DLRSP/django-requests-api
+Project-URL: Documentation, https://github.com/DLRSP/django-requests-api/
+Project-URL: Repository, https://github.com/DLRSP/django-requests-api
+Project-URL: Issues, https://github.com/DLRSP/django-requests-api/issues
+Project-URL: Changelog, https://github.com/DLRSP/django-requests-api/blob/main/CHANGELOG.rst
+Keywords: django,requests,http,api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Requires-Dist: requests>=2.32.5
+Provides-Extra: testing
+Requires-Dist: coverage; extra == "testing"
+Requires-Dist: codecov; extra == "testing"
+Provides-Extra: linting
+Requires-Dist: flake8; extra == "linting"
+Requires-Dist: Flake8-pyproject; extra == "linting"
+Requires-Dist: pylint; extra == "linting"
+Dynamic: license-file
+
+# django-requests-api [![PyPi license](https://img.shields.io/pypi/l/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+
+[![PyPi status](https://img.shields.io/pypi/status/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![PyPi version](https://img.shields.io/pypi/v/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![PyPi python version](https://img.shields.io/pypi/pyversions/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![codecov.io](https://codecov.io/github/DLRSP/django-requests-api/coverage.svg?branch=master)](https://codecov.io/github/DLRSP/django-requests-api?branch=master)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DLRSP/django-requests-api/master.svg)](https://results.pre-commit.ci/latest/github/DLRSP/django-requests-api/master)
+[![CI](https://github.com/DLRSP/django-requests-api/actions/workflows/ci.yaml/badge.svg)](https://github.com/DLRSP/django-requests-api/actions/workflows/ci.yaml)
+
+## Demo
+
+- [Heroku demo](https://django-requests-api.herokuapp.com/) (if still online)
+- [Example branch](https://github.com/DLRSP/example/tree/django-requests-api) on DLRSP/example
+
+## Requirements
+
+- Python 3.9+
+- Django 4.2+ (see package classifiers for the full matrix)
+
+## Install
+
+```shell
+pip install django-requests-api
+```
+
+```python
+INSTALLED_APPS = (
+    # ...
+    "requests_api",
+    # ...
+)
+```
+
+## Usage
+
+```python
+from requests_api import RequestsApi
+
+client = RequestsApi("https://api.publicapis.org")
+r = client.get("/entries")
+print(r.json())
+
+github = RequestsApi(
+    "https://api.github.com",
+    headers={"Authorization": "token abcdef"},
+)
+r = github.get("/user", headers={"Accept": "application/json"})
+print(r.text)
+```
+
+Paths are joined to `base_url` with a single slash. Absolute URLs (`http://` / `https://`) are passed through unchanged. The package depends on **requests** (`install_requires`).
+
+### Helpers
+
+Implementation: `requests_api.requests_api` and `requests_api.helpers`; public imports from the package root:
+
+```python
+from requests_api import (
+    copy_get_params_with_overrides,
+    normalize_api_language,
+    requests_api_for_base,
+)
+
+lang = normalize_api_language(
+    request.LANGUAGE_CODE,
+    allowed=("it", "en"),
+    fallback="en",
+)
+params = copy_get_params_with_overrides(request, lang=lang)
+client = requests_api_for_base("https://www.example.com")
+r = client.get("api/resource", params=params, timeout=30)
+```
+
+### Configuration (`APP_CONFIG` / `REQUESTS_API_*`)
+
+Read via **`requests_api.conf`**: Django settings first, then **`APP_CONFIG["requests_api"]`**, then defaults.
+
+| `APP_CONFIG["requests_api"]` | Django setting | Notes |
+|------------------------------|----------------|--------|
+| `CACHED_CLIENTS_MAXSIZE` | `REQUESTS_API_CACHED_CLIENTS_MAXSIZE` | Cap for `requests_api_for_base` (default `8`). `0` or below turns caching off. |
+| `DEFAULT_REQUEST_TIMEOUT` | `REQUESTS_API_DEFAULT_REQUEST_TIMEOUT` | Optional seconds; default `None`. Not applied automatically—call `get_requests_api_default_request_timeout()` and pass `timeout=` yourself if you want a shared value. |
+
+```python
+from requests_api import get_requests_api_default_request_timeout
+
+timeout = get_requests_api_default_request_timeout()
+client = requests_api_for_base("https://api.example.com")
+r = client.get("v1/x", timeout=timeout if timeout is not None else 30)
+```
+
+In tests, call **`clear_requests_api_client_cache()`** when you change cache settings. Full write-up: `docs/tutorial/configuration.md` (MkDocs: *Tutorials → Configuration*).
+
+## Run the example locally
+
+```shell
+git clone --depth=50 --branch=django-requests-api https://github.com/DLRSP/example.git example-requests-api
+cd example-requests-api
+python manage.py runserver
+```
+
+Then open http://127.0.0.1:8000 (install dependencies from that repo’s `requirements/` first).
+
+## Docs
+
+MkDocs sources live under `docs/`. See [Contributing](docs/community/contributing.md) for `mkdocs serve`.
+
+- [References & ecosystem](docs/community/references.md)
+- [HTTP status codes (quick reference)](docs/community/http-status-codes.md)
+
+## Used in
+
+Public GitHub projects that reference **django-requests-api** / `requests_api` (weekly sync via [`.github/used-in.yaml`](.github/used-in.yaml) and [`update-used-in`](https://github.com/DLRSP/workflows/blob/main/.github/workflows/update-used-in.yaml)):
+
+<!-- used-in:auto-start -->
+- ![GitHub stars](https://img.shields.io/github/stars/DLRSP/django-iubenda?label=%E2%AD%90&style=flat-square) [django-iubenda](https://github.com/DLRSP/django-iubenda#readme) — Django application for privacy and cookies policy managed by Iubenda.
+<!-- used-in:auto-end -->
+
+Missing a project? Open a PR or run the workflow manually in your fork.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_requests_api-0.6.6/README.md

@@ -0,0 +1,122 @@
+# django-requests-api [![PyPi license](https://img.shields.io/pypi/l/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+
+[![PyPi status](https://img.shields.io/pypi/status/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![PyPi version](https://img.shields.io/pypi/v/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![PyPi python version](https://img.shields.io/pypi/pyversions/django-requests-api.svg)](https://pypi.python.org/pypi/django-requests-api)
+[![codecov.io](https://codecov.io/github/DLRSP/django-requests-api/coverage.svg?branch=master)](https://codecov.io/github/DLRSP/django-requests-api?branch=master)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DLRSP/django-requests-api/master.svg)](https://results.pre-commit.ci/latest/github/DLRSP/django-requests-api/master)
+[![CI](https://github.com/DLRSP/django-requests-api/actions/workflows/ci.yaml/badge.svg)](https://github.com/DLRSP/django-requests-api/actions/workflows/ci.yaml)
+
+## Demo
+
+- [Heroku demo](https://django-requests-api.herokuapp.com/) (if still online)
+- [Example branch](https://github.com/DLRSP/example/tree/django-requests-api) on DLRSP/example
+
+## Requirements
+
+- Python 3.9+
+- Django 4.2+ (see package classifiers for the full matrix)
+
+## Install
+
+```shell
+pip install django-requests-api
+```
+
+```python
+INSTALLED_APPS = (
+    # ...
+    "requests_api",
+    # ...
+)
+```
+
+## Usage
+
+```python
+from requests_api import RequestsApi
+
+client = RequestsApi("https://api.publicapis.org")
+r = client.get("/entries")
+print(r.json())
+
+github = RequestsApi(
+    "https://api.github.com",
+    headers={"Authorization": "token abcdef"},
+)
+r = github.get("/user", headers={"Accept": "application/json"})
+print(r.text)
+```
+
+Paths are joined to `base_url` with a single slash. Absolute URLs (`http://` / `https://`) are passed through unchanged. The package depends on **requests** (`install_requires`).
+
+### Helpers
+
+Implementation: `requests_api.requests_api` and `requests_api.helpers`; public imports from the package root:
+
+```python
+from requests_api import (
+    copy_get_params_with_overrides,
+    normalize_api_language,
+    requests_api_for_base,
+)
+
+lang = normalize_api_language(
+    request.LANGUAGE_CODE,
+    allowed=("it", "en"),
+    fallback="en",
+)
+params = copy_get_params_with_overrides(request, lang=lang)
+client = requests_api_for_base("https://www.example.com")
+r = client.get("api/resource", params=params, timeout=30)
+```
+
+### Configuration (`APP_CONFIG` / `REQUESTS_API_*`)
+
+Read via **`requests_api.conf`**: Django settings first, then **`APP_CONFIG["requests_api"]`**, then defaults.
+
+| `APP_CONFIG["requests_api"]` | Django setting | Notes |
+|------------------------------|----------------|--------|
+| `CACHED_CLIENTS_MAXSIZE` | `REQUESTS_API_CACHED_CLIENTS_MAXSIZE` | Cap for `requests_api_for_base` (default `8`). `0` or below turns caching off. |
+| `DEFAULT_REQUEST_TIMEOUT` | `REQUESTS_API_DEFAULT_REQUEST_TIMEOUT` | Optional seconds; default `None`. Not applied automatically—call `get_requests_api_default_request_timeout()` and pass `timeout=` yourself if you want a shared value. |
+
+```python
+from requests_api import get_requests_api_default_request_timeout
+
+timeout = get_requests_api_default_request_timeout()
+client = requests_api_for_base("https://api.example.com")
+r = client.get("v1/x", timeout=timeout if timeout is not None else 30)
+```
+
+In tests, call **`clear_requests_api_client_cache()`** when you change cache settings. Full write-up: `docs/tutorial/configuration.md` (MkDocs: *Tutorials → Configuration*).
+
+## Run the example locally
+
+```shell
+git clone --depth=50 --branch=django-requests-api https://github.com/DLRSP/example.git example-requests-api
+cd example-requests-api
+python manage.py runserver
+```
+
+Then open http://127.0.0.1:8000 (install dependencies from that repo’s `requirements/` first).
+
+## Docs
+
+MkDocs sources live under `docs/`. See [Contributing](docs/community/contributing.md) for `mkdocs serve`.
+
+- [References & ecosystem](docs/community/references.md)
+- [HTTP status codes (quick reference)](docs/community/http-status-codes.md)
+
+## Used in
+
+Public GitHub projects that reference **django-requests-api** / `requests_api` (weekly sync via [`.github/used-in.yaml`](.github/used-in.yaml) and [`update-used-in`](https://github.com/DLRSP/workflows/blob/main/.github/workflows/update-used-in.yaml)):
+
+<!-- used-in:auto-start -->
+- ![GitHub stars](https://img.shields.io/github/stars/DLRSP/django-iubenda?label=%E2%AD%90&style=flat-square) [django-iubenda](https://github.com/DLRSP/django-iubenda#readme) — Django application for privacy and cookies policy managed by Iubenda.
+<!-- used-in:auto-end -->
+
+Missing a project? Open a PR or run the workflow manually in your fork.
+
+## License
+
+MIT — see [LICENSE](LICENSE).

django_requests_api-0.6.6/mkdocs.yml

@@ -0,0 +1,66 @@
+site_name: django-requests-api
+site_url: https://github.com/DLRSP/django-requests-api/
+site_description: Thin requests.Session wrapper and helpers for Django projects.
+
+repo_name: DLRSP/django-requests-api
+repo_url: https://github.com/DLRSP/django-requests-api/
+
+theme:
+  name: material
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.top
+    - content.code.annotate
+    - content.tabs.link
+    - search.suggest
+    - search.highlight
+  icon:
+    repo: fontawesome/brands/github-alt
+
+plugins:
+  - search
+  - git-revision-date
+
+extra:
+  analytics:
+    provider: google
+    property: G-7VL775RPH9
+  social:
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/DlrspTwits
+      name: DLRSP on Twitter
+    - icon: fontawesome/solid/paper-plane
+      link: mailto:dlrsp.dev@gmail.com
+    - icon: fontawesome/brands/github
+      link: https://github.com/DLRSP
+
+markdown_extensions:
+  - toc:
+      anchorlink: true
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+  - pymdownx.inlinehilite:
+  - pymdownx.superfences:
+  - pymdownx.snippets:
+
+nav:
+  - Home: index.md
+  - Tutorials:
+      - Example project: tutorial/example.md
+      - Configuration: tutorial/configuration.md
+  - Community:
+      - References: community/references.md
+      - HTTP status codes: community/http-status-codes.md
+      - Contributing: community/contributing.md
+
+copyright: Copyright © 2010-present DLRSP

django_requests_api-0.6.6/pyproject.toml

@@ -0,0 +1,182 @@
+[build-system]
+requires = [
+  "setuptools >= 77",
+  "wheel",
+]
+build-backend = "setuptools.build_meta"
+[project]
+name = "django-requests-api"
+description = "Django application providing a thin requests.Session wrapper with a base URL and small HTTP helpers."
+authors = [
+    { name = "DLRSP", email = "dlrsp.dev@gmail.com" },
+]
+requires-python = ">=3.10"
+dynamic = [
+    "version",
+]
+readme = "README.md"
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+keywords = [
+    "django",
+    "requests",
+    "http",
+    "api",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.2",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = [
+    "Django>=3.2",
+    "requests>=2.32.5",
+]
+
+[project.urls]
+Homepage = "https://github.com/DLRSP/django-requests-api"
+Documentation = "https://github.com/DLRSP/django-requests-api/"
+Repository = "https://github.com/DLRSP/django-requests-api"
+Issues = "https://github.com/DLRSP/django-requests-api/issues"
+Changelog = "https://github.com/DLRSP/django-requests-api/blob/main/CHANGELOG.rst"
+
+[project.optional-dependencies]
+testing = [
+    "coverage",
+    "codecov",
+]
+linting = [
+    "flake8",
+    "Flake8-pyproject",
+    "pylint",
+]
+
+[tool.setuptools]
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.dynamic.version]
+attr = "requests_api.__version__"
+
+[tool.setuptools.packages.find]
+where = [
+    "src",
+]
+
+
+[tool.setuptools.data-files]
+"share/django-requests-api/requirements" = [
+  "requirements/py310-django42.txt",
+  "requirements/py310-django52.txt",
+  "requirements/py311-django42.txt",
+  "requirements/py311-django52.txt",
+  "requirements/py312-django42.txt",
+  "requirements/py312-django52.txt",
+  "requirements/py313-django52.txt",
+  "requirements/py314-django52.txt",
+]
+[tool.distutils.bdist_wheel]
+universal = false
+
+[tool.black]
+line-length = 80
+target-version = ['py311']
+[tool.isort]
+profile = "black"
+
+[tool.check-manifest]
+ignore = [
+    "AGENTS.md",
+    "docs/community/third-party-packages.md",
+    "docs/tutorial/customize.md",
+]
+
+# Read by flake8 when flake8-pyproject is installed (extra `linting`).
+[tool.flake8]
+max-line-length = 80
+select = ["E", "F", "W", "B", "B950", "C", "I", "TYP"]
+ignore = ["E203", "E501", "W503", "B950"]
+per-file-ignores = [
+    "**/migrations/*:B950",
+]
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+mypy_path = "src/"
+no_implicit_optional = true
+show_error_codes = true
+warn_unreachable = true
+warn_unused_ignores = true
+overrides = [
+    { module = "tests.*", allow_untyped_defs = true },
+]
+
+[tool.pytest.ini_options]
+addopts = "--strict-config\n    --strict-markers\n    --ds=tests.settings\n    "
+django_find_project = false
+
+[tool.coverage.paths]
+source = [
+    "src",
+    ".tox/*/site-packages",
+]
+
+[tool.coverage.run]
+branch = true
+source = [
+    "requests_api",
+]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.towncrier]
+package = "requests_api"
+package_dir = "src"
+filename = "CHANGELOG.rst"
+directory = "news/"
+version = "0.6.6"
+issue_format = "`#{issue} <https://github.com/DLRSP/django-requests-api/issues/{issue}>`_"
+type = [
+    { name = "Process", directory = "process", showcontent = true },
+    { name = "Deprecations and Removals", directory = "removal", showcontent = true },
+    { name = "Features", directory = "feature", showcontent = true },
+    { name = "Bug Fixes", directory = "bugfix", showcontent = true },
+    { name = "Vendored Libraries", directory = "vendor", showcontent = true },
+    { name = "Improved Documentation", directory = "doc", showcontent = true },
+    { name = "Trivial Changes", directory = "trivial", showcontent = false },
+]
+
+[tool.bumpversion]
+current_version = "0.6.6"
+allow_dirty = true
+files = [
+    { filename = "./src/requests_api/__init__.py" },
+    { filename = "pyproject.toml", search = 'version = "{current_version}"', replace = 'version = "{new_version}"' },
+]