EN SDK Installation

Python SDK installation and client selection

English · Türkçe · Languages / Diller

Scope: JSON API Forge 0.5.1 · Source review: 17 September 2026 · Language: English

The distribution is json-api-forge-client and the import is json_api_forge. It differs from the server package json-api-forge. Installing the SDK does not install an HTTP server, database or desktop Editor.

Install a pinned commit

python -m venv .venv
# Linux/macOS: source .venv/bin/activate
# Windows: .\.venv\Scripts\Activate.ps1
python -m pip install "json-api-forge-client @ git+https://github.com/YoungLionOrganization/JSON-API-Forge.git@9507fa902838f66400a603cea22b271a79d4eb9c"
python -c "import json_api_forge; print(json_api_forge.__version__)"

Use python-library for development and a pinned commit for reproducible deployments. The Git tag v0.5.1 points to the server; using it here can select a different package. Use the verified official distribution path rather than assuming a bare package name has been published to a public registry.

Python metadata requires >=3.10; official tests cover 3.10–3.14. The primary dependency is httpx; YoungLion/DDM is optional. The intended pure-Python wheel tag is py3-none-any.

Clients

Class	Use
ForgeClient	Synchronous application API
AsyncForgeClient	asyncio application API
ForgeCluster	Multiple endpoints, routing/failover and synchronous bulk
AsyncForgeCluster	Async routing and bounded concurrent bulk
EditorControlPlaneClient	Team/document management
AsyncEditorControlPlaneClient	Async management client

Application API keys do not replace control-plane login. Reuse clients over their intended lifetime to benefit from connection pools; constructing one per request adds connection overhead. Close them with context managers or close/aclose.

Base URL contract

Helpers construct /api/<slug>/v1/.... A typical base URL is https://api.example.com, with project argument wiki-demo. Do not also append /api/wiki-demo/v1 to the base when using those helpers.

For custom API prefixes or different methods/paths, use request() with the actual relative path. Control-plane clients construct /__forge/editor/v1 themselves, so give them the server origin/deployment base too.

Remote HTTP is rejected. allow_insecure_http=True permits HTTP only for loopback development, not arbitrary LAN/public hosts. Embedded URL credentials, fragments, traversal and absolute requests to another origin are rejected.

Release-specific detail

The reviewed v0.5.1 SDK asset uses py3-none-any_lib.whl, which differs from the intended py3-none-any tag. This guide installs the pinned SDK source commit. If a wheel tag is unsupported, check the asset and correct sdist/source route before randomly changing Python versions.

Complete constructors and methods: SDK references.

Sources and verification

This page describes the behavior at the pinned commits below. Recheck these contracts when upgrading.

• python-library/pyproject.toml
• python-library/json_api_forge/__init__.py
• python-library/json_api_forge/client.py

---

English home · All English pages · Version maintenance