docs: add Python SDK, update to v1.0.0

- Quick start now covers both Express.js and FastAPI/Starlette
- Configuration page documents all options for both SDKs with code tabs
- Dashboard page notes the UI is shared across SDKs
- Insights and Release Tracking pages add Python examples
- Homepage features mention both Node.js and Python SDKs
- Nav version bump 0.1.0 → 1.0.0, add PyPI link and Python changelog

Author: Fabien83560

docs/.vitepress/config.js

@@ -21,10 +21,12 @@ export default defineConfig({
       { text: 'Features', link: '/features/insights' },
       { text: 'API Reference', link: '/guide/configuration' },
       {
-        text: 'v0.1.0',
+        text: 'v1.0.0',
         items: [
-          { text: 'Changelog', link: 'https://github.com/APIForge-Organisation/sdk-nodejs/blob/main/CHANGELOG.md' },
-          { text: 'npm', link: 'https://www.npmjs.com/package/apiforgejs' },
+          { text: 'Changelog (Node.js)', link: 'https://github.com/APIForge-Organisation/sdk-nodejs/blob/main/CHANGELOG.md' },
+          { text: 'Changelog (Python)', link: 'https://github.com/APIForge-Organisation/sdk-python/blob/main/CHANGELOG.md' },
+          { text: 'npm — apiforgejs', link: 'https://www.npmjs.com/package/apiforgejs' },
+          { text: 'PyPI — apiforgepy', link: 'https://pypi.org/project/apiforgepy/' },
         ],
       },
     ],
@@ -61,6 +63,7 @@ export default defineConfig({
     socialLinks: [
       { icon: 'github', link: 'https://github.com/APIForge-Organisation' },
       { icon: 'npm', link: 'https://www.npmjs.com/package/apiforgejs' },
+      { icon: { svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>PyPI</title><path d="M12 0C5.373 0 0 5.373 0 12s5.373 12 12 12 12-5.373 12-12S18.627 0 12 0zm-.535 2.636c2.11 0 3.532.478 4.181 1.072.649.593.787 1.377.787 2.206v4.073c0 .843-.638 1.56-1.48 1.56H9.027c-1.156 0-2.086.945-2.086 2.1v1.574H4.87c-.86 0-1.322-.614-1.322-1.574V7.18c0-2.473 2.107-4.544 7.917-4.544zm-.34 1.406c-.607 0-1.099.493-1.099 1.1s.492 1.099 1.099 1.099c.607 0 1.099-.492 1.099-1.1 0-.606-.492-1.099-1.1-1.099zm4.772 8.205v1.574c0 .96-.463 1.574-1.322 1.574h-2.07v1.574c0 1.156-.93 2.1-2.087 2.1H5.502c-.842 0-1.48-.717-1.48-1.56v-4.073c0-.829.138-1.613.787-2.206.649-.594 2.07-1.072 4.18-1.072 5.811 0 7.918 2.07 7.918 4.544v-.455zm-3.83 4.648c-.607 0-1.1.492-1.1 1.099s.493 1.099 1.1 1.099c.606 0 1.098-.492 1.098-1.1 0-.606-.492-1.098-1.099-1.098z"/></svg>' }, link: 'https://pypi.org/project/apiforgepy/' },
     ],
 
     editLink: {

docs/features/insights.md

@@ -22,7 +22,7 @@ Identifies endpoints that have received no traffic for an extended period — sa
 
 > *"`DELETE /legacy/import` has received no requests in 23 days. Consider deprecating this endpoint."*
 
-**Triggers when:** An endpoint has zero requests for the past **21 days** (configurable via `deadThresholdDays`).
+**Triggers when:** An endpoint has zero requests for the past **21 days**.
 
 ---
 
@@ -53,11 +53,24 @@ Insights are sorted by severity in the dashboard:
 
 Set the `release` option to activate `PERF` and `OK` insights:
 
-```js
+::: code-group
+
+```js [Node.js]
 app.use(apiforge({
   mode: 'local',
-  release: process.env.npm_package_version, // e.g. '1.4.0'
+  release: process.env.npm_package_version,
 }))
 ```
 
+```python [Python]
+import os
+app.add_middleware(
+    ApiForgeMiddleware,
+    mode="local",
+    release=os.environ.get("RELEASE"),
+)
+```
+
+:::
+
 Each time the value changes (i.e. on a new deploy), APIForge creates a comparison baseline automatically.

docs/features/release-tracking.md

@@ -6,22 +6,40 @@ Release tracking automatically compares your API's performance before and after
 
 Pass the current version as the `release` option:
 
-```js
+::: code-group
+
+```js [Node.js]
 app.use(apiforge({
   mode: 'local',
   release: process.env.npm_package_version,
 }))
 ```
 
+```python [Python]
+import os
+app.add_middleware(
+    ApiForgeMiddleware,
+    mode="local",
+    release=os.environ.get("RELEASE"),
+)
+```
+
+:::
+
 Or hardcode it during the deploy process:
 
-```js
-app.use(apiforge({
-  mode: 'local',
-  release: 'v1.4.0',
-}))
+::: code-group
+
+```js [Node.js]
+app.use(apiforge({ mode: 'local', release: 'v1.4.0' }))
+```
+
+```python [Python]
+app.add_middleware(ApiForgeMiddleware, mode="local", release="v1.4.0")
 ```
 
+:::
+
 ::: tip Automate with environment variables
 Most CI/CD systems expose the version or git tag as an environment variable. Inject it at build time so it changes automatically on every deploy.
 :::

docs/guide/configuration.md

@@ -1,5 +1,7 @@
 # Configuration
 
+## Node.js
+
 All options are passed to the `apiforge()` factory. Every option is optional except `mode`.
 
 ```js
@@ -16,82 +18,113 @@ app.use(apiforge({
 }))
 ```
 
+## Python
+
+All options are passed to `ApiForgeMiddleware`. Every option is optional except `mode`.
+
+```python
+app.add_middleware(
+    ApiForgeMiddleware,
+    mode="local",
+    db_path=".apiforge.db",
+    dashboard_port=4242,
+    flush_interval=60,
+    env="production",
+    release="v1.4.0",
+    service="user-service",
+    sampling=1.0,
+    ignore_paths=["/favicon.ico", "/health"],
+)
+```
+
+::: tip Python naming
+Python uses `snake_case` for option names. `flush_interval` is in **seconds** (not milliseconds).
+:::
+
+---
+
 ## Options
 
-### `mode`
+### `mode` / `mode`
 
 - **Type:** `'local'`
 - **Required:** yes
-- **Default:** —
 
-The storage and transport mode. Only `'local'` (SQLite) is available in v0.x. SaaS mode is planned for v1.0.
+The storage and transport mode. Only `'local'` (SQLite) is available. SaaS mode is planned for a future version.
 
 ---
 
-### `dbPath`
+### `dbPath` / `db_path`
 
 - **Type:** `string`
 - **Default:** `'.apiforge.db'`
 
-Path to the SQLite database file. The file is created automatically if it does not exist.
-
-```js
-apiforge({ mode: 'local', dbPath: '/var/data/apiforge.db' })
-```
+Path to the SQLite database file. Created automatically if it does not exist.
 
 ---
 
-### `dashboardPort`
+### `dashboardPort` / `dashboard_port`
 
-- **Type:** `number`
+- **Type:** `number` / `int`
 - **Default:** `4242`
 
 Port for the local dashboard HTTP server. Set to `0` to disable the dashboard entirely.
 
 ```js
-apiforge({ mode: 'local', dashboardPort: 0 })  // no dashboard
-apiforge({ mode: 'local', dashboardPort: 9000 }) // custom port
+// Node.js
+apiforge({ mode: 'local', dashboardPort: 0 })    // no dashboard
+apiforge({ mode: 'local', dashboardPort: 9000 })  // custom port
+```
+
+```python
+# Python
+ApiForgeMiddleware(mode="local", dashboard_port=0)     # no dashboard
+ApiForgeMiddleware(mode="local", dashboard_port=9000)  # custom port
 ```
 
 ---
 
-### `flushInterval`
+### `flushInterval` / `flush_interval`
 
-- **Type:** `number` (milliseconds)
-- **Default:** `60000` (60 seconds)
+- **Type (Node.js):** `number` (milliseconds) — Default: `60000`
+- **Type (Python):** `int` (seconds) — Default: `60`
 
-How often the in-memory buffer is flushed to SQLite. Lower values give more granular data at the cost of more frequent writes.
+How often the in-memory buffer is flushed to SQLite.
 
 ::: warning Minimum recommended value
-Values below `5000` (5s) may impact performance under high traffic. The default of 60s is appropriate for most applications.
+Values below 5 seconds may impact performance under high traffic. The default of 60s is appropriate for most applications.
 :::
 
 ---
 
 ### `env`
 
 - **Type:** `string`
-- **Default:** `process.env.NODE_ENV ?? 'production'`
+- **Default (Node.js):** `process.env.NODE_ENV ?? 'production'`
+- **Default (Python):** `'production'`
 
-Environment label stored with each metric. Useful when running multiple environments pointing to the same database.
-
-```js
-apiforge({ mode: 'local', env: process.env.NODE_ENV })
-```
+Environment label stored with each metric.
 
 ---
 
 ### `release`
 
 - **Type:** `string | null`
-- **Default:** `process.env.APP_VERSION ?? null`
+- **Default:** `null`
 
 Version tag for the current deployment. When provided, APIForge creates a comparison point in the timeline and generates before/after insights after each deploy.
 
 ```js
+// Node.js
 apiforge({ mode: 'local', release: process.env.npm_package_version })
 ```
 
+```python
+# Python
+import os
+ApiForgeMiddleware(mode="local", release=os.environ.get("RELEASE"))
+```
+
 See [Release Tracking](/features/release-tracking) for details.
 
 ---
@@ -103,42 +136,29 @@ See [Release Tracking](/features/release-tracking) for details.
 
 Service name, used to distinguish multiple APIs sharing the same database.
 
-```js
-apiforge({ mode: 'local', service: 'payment-api' })
-```
-
 ---
 
 ### `sampling`
 
-- **Type:** `number` (0.0 – 1.0)
+- **Type:** `number / float` (0.0 – 1.0)
 - **Default:** `1.0`
 
 Fraction of requests to instrument. Set below `1.0` under very high traffic to reduce overhead.
 
-```js
-apiforge({ mode: 'local', sampling: 0.1 }) // instrument 10% of requests
-```
-
 ---
 
-### `ignorePaths`
+### `ignorePaths` / `ignore_paths`
 
-- **Type:** `string[]`
+- **Type:** `string[]` / `list[str]`
 - **Default:** `['/favicon.ico']`
 
 Paths to exclude from instrumentation. Supports exact matches.
 
-```js
-apiforge({
-  mode: 'local',
-  ignorePaths: ['/favicon.ico', '/health', '/ready', '/metrics'],
-})
-```
+---
 
 ## Graceful shutdown
 
-The middleware exposes a `shutdown()` method for clean teardown (flushes the buffer and closes the SQLite connection):
+### Node.js
 
 ```js
 const mw = apiforge({ mode: 'local' })
@@ -149,3 +169,14 @@ process.on('SIGTERM', () => {
   server.close()
 })
 ```
+
+### Python
+
+```python
+import atexit
+
+mw = ApiForgeMiddleware(mode="local")
+app.add_middleware(mw)
+
+atexit.register(mw.shutdown)
+```

docs/guide/dashboard.md

@@ -1,6 +1,6 @@
 # Local Dashboard
 
-The local dashboard is a built-in web UI served automatically by the SDK on port 4242 (configurable).
+The local dashboard is a built-in web UI served automatically by the SDK on port 4242 (configurable). It is identical across all SDKs — the same interface whether you run Node.js or Python.
 
 ```
 http://localhost:4242
@@ -35,7 +35,7 @@ All instrumented routes, sorted by request volume. Columns:
 
 | Column | Description |
 |---|---|
-| Route | Parameterized pattern — e.g. `GET /users/:id` |
+| Route | Parameterized pattern — e.g. `GET /users/:id` or `GET /users/{user_id}` |
 | Requests | Total calls in the selected time range |
 | P50 / P90 / P99 | Latency percentiles in milliseconds |
 | Error rate | Percentage of 4xx + 5xx responses |
@@ -47,21 +47,34 @@ Automatically generated alerts — no configuration required. See [Automatic Ins
 
 ## Disabling the dashboard
 
-Set `dashboardPort: 0` in your config:
+::: code-group
 
-```js
+```js [Node.js]
 app.use(apiforge({ mode: 'local', dashboardPort: 0 }))
 ```
 
-This is useful in production environments where you don't want to expose an extra port, or in test environments.
+```python [Python]
+app.add_middleware(ApiForgeMiddleware, mode="local", dashboard_port=0)
+```
+
+:::
 
 ## Custom port
 
-```js
+::: code-group
+
+```js [Node.js]
 app.use(apiforge({ mode: 'local', dashboardPort: 9090 }))
 // Dashboard → http://localhost:9090
 ```
 
+```python [Python]
+app.add_middleware(ApiForgeMiddleware, mode="local", dashboard_port=9090)
+# Dashboard → http://localhost:9090
+```
+
+:::
+
 ## Security note
 
 The dashboard has no authentication in local mode. **Do not expose port 4242 to the public internet.** Use a firewall rule or SSH tunnel if you need to access it remotely: