Skip to content

docs: Create separate pypi.md files for each Python package #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dagardner-nv wants to merge 16 commits into from
Closed

docs: Create separate pypi.md files for each Python package #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6fb2616
refactor: slim adapter runtime dependencies (#105)
zhongxuanwang-nv Jul 28, 2026
e36318e
Merge branch 'release/0.1' of github.com:NVIDIA/NeMo-Fabric into rele…
dagardner-nv Jul 29, 2026
55c5f74
Remove crates.io and pypi badges from the pypi readme
dagardner-nv Jul 28, 2026
ad2ab12
Split readme into pypi files
dagardner-nv Jul 28, 2026
c8f0c84
Split readme into pypi files
dagardner-nv Jul 29, 2026
db7c134
Add homepage and issues links, use exact url casing
dagardner-nv Jul 29, 2026
4dec2f8
Add homepage and issues links, use exact url casing
dagardner-nv Jul 29, 2026
30a06e6
Cleanup install instructions
dagardner-nv Jul 29, 2026
5f77c10
Restore testing section, removing the testing.md
dagardner-nv Jul 29, 2026
7b523dc
re-phrase
dagardner-nv Jul 29, 2026
fc8fe1b
Slim down to installation only
dagardner-nv Jul 29, 2026
ba74096
Trim down the pypi readme files to just installation instructions
dagardner-nv Jul 29, 2026
1d03a5b
Merge testing information back into the README
dagardner-nv Jul 29, 2026
ff16134
Add NeMo Fabric logo image to all pypi.md files
dagardner-nv Jul 29, 2026
a6adfba
Trim down the main pypi file
dagardner-nv Jul 29, 2026
eb43f96
Restore the learn more section
dagardner-nv Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions adapters/claude/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,23 @@ assert first.output["session_id"] == second.output["session_id"]
The runtime must remain on the same local host for its lifetime. A persisted
NeMo Fabric-to-Claude correlation record is not an attach token and cannot recover a
stopped or crashed local host.


## Testing

The default suite uses deterministic mock Claude Code and Relay CLIs and
requires no credentials. Test a current `nemo-relay` CLI with the mock Claude
client, or run the live integrations on an authenticated developer host:

```bash
FABRIC_NEMO_RELAY_COMMAND="$(command -v nemo-relay)" uv run --no-sync pytest tests/e2e/test_claude.py -q -k real_relay_gateway
RUN_FABRIC_CLAUDE_INTEGRATION=1 uv run --no-sync pytest tests/e2e/test_claude.py -q -k live
RUN_FABRIC_CLAUDE_RELAY_INTEGRATION=1 uv run --no-sync pytest tests/e2e/test_claude.py -q -k live_claude_relay
```

The first command uses the mock Claude client and does not require credentials.
Set `FABRIC_TEST_CLAUDE_MODEL` to override the default live-test model,
`claude-sonnet-4-5`.
The live Relay test applies the same semantic artifact contract as Codex: ATOF
must contain structured LLM requests and token usage, and ATIF must contain the
expected agent response.
29 changes: 29 additions & 0 deletions adapters/claude/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# NVIDIA NeMo Fabric Claude Adapter

[![License](https://img.shields.io/github/license/NVIDIA/NeMo-Fabric)](https://github.com/NVIDIA/NeMo-Fabric/blob/main/LICENSE)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/NVIDIA/NeMo-Fabric/)
[![Release](https://img.shields.io/github/v/release/NVIDIA/NeMo-Fabric?color=green)](https://github.com/NVIDIA/NeMo-Fabric/releases)

![Diagram showing NeMo Fabric connecting applications, evaluations, and reinforcement learning rollouts to Hermes, Codex, Claude, and Deep Agents, with results, artifacts, and telemetry as outputs.](https://raw.githubusercontent.com/NVIDIA/NeMo-Fabric/refs/heads/main/assets/fabric-hero-option2.png)

Provides a NeMo Fabric adapter for use with [Claude Code](https://claude.com/).

## Install

Installation can be performed using the `nemo-fabric` meta package with the `claude` extra, or by installing the adapter and harness packages separately. The following table shows which components each installation provides:

| Installation | Runtime | Adapter | Harness | NeMo Relay CLI |
| --- | --- | --- | --- | --- |
| `pip install "nemo-fabric[claude]"` | Yes | Yes | Yes | No |
| `pip install "nemo-fabric-adapters-claude[harness]"` | No | Yes | Yes | No |
| `pip install nemo-fabric-adapters-claude` | No | Yes | No | No |

The `full` extra is equivalent to `harness`. Relay is optional for ordinary
runs. NeMo Relay telemetry and streaming require the `nemo-relay` CLI tool to be installed, refer to the [NeMo Relay installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#nemo-relay-cli).

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
6 changes: 4 additions & 2 deletions adapters/claude/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ classifiers = [
]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
readme = "pypi.md"
requires-python = ">=3.11"
dependencies = [
"nemo-fabric-adapters-common == 0.1.0",
Expand All @@ -38,7 +38,9 @@ full = [
]

[project.urls]
Repository = "https://github.com/NVIDIA/nemo-fabric/"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"

[tool.setuptools.packages.find]
Expand Down
23 changes: 0 additions & 23 deletions adapters/claude/testing.md
View file
Open in desktop

This file was deleted.

25 changes: 25 additions & 0 deletions adapters/codex/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,3 +144,28 @@ installed `nemo-relay` CLI as a supervised sidecar; do not start the gateway
separately.
NeMo Fabric routes the selected Responses-compatible provider through the
gateway and passes its explicit `base_url` to Relay as the upstream endpoint.


## Testing

Run the unit and opt-in real SDK tests separately:

```bash
uv run pytest tests/adapters/test_codex_adapter.py -q
RUN_FABRIC_CODEX_INTEGRATION=1 uv run pytest tests/e2e/test_codex.py -q
RUN_FABRIC_CODEX_RELAY_INTEGRATION=1 \
FABRIC_TEST_NEMO_RELAY_COMMAND=/path/to/nemo-relay \
uv run pytest tests/e2e/test_codex.py -q
```

Set `FABRIC_TEST_CODEX_BIN=/path/to/codex` on either opt-in command to validate
an explicit app-server override instead of the SDK-pinned runtime.
Comment on lines +156 to +162

@coderabbitai coderabbitai Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use explicit angle-bracketed path placeholders.

/path/to/nemo-relay and /path/to/codex should be represented as placeholders, not literal paths. Quote them so the commands remain valid shell examples.

Proposed wording 
-  FABRIC_TEST_NEMO_RELAY_COMMAND=/path/to/nemo-relay \
+  FABRIC_TEST_NEMO_RELAY_COMMAND="<path-to-nemo-relay>" \
...
-Set `FABRIC_TEST_CODEX_BIN=/path/to/codex` on either opt-in command to validate
+Set `FABRIC_TEST_CODEX_BIN="<path-to-codex>"` on either opt-in command to validate

As per coding guidelines, represent path placeholders as angle-bracketed values inside monospace.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
RUN_FABRIC_CODEX_RELAY_INTEGRATION=1 \
FABRIC_TEST_NEMO_RELAY_COMMAND=/path/to/nemo-relay \
uv run pytest tests/e2e/test_codex.py -q
```
Set `FABRIC_TEST_CODEX_BIN=/path/to/codex` on either opt-in command to validate
an explicit app-server override instead of the SDK-pinned runtime.
RUN_FABRIC_CODEX_RELAY_INTEGRATION=1 \
FABRIC_TEST_NEMO_RELAY_COMMAND="<path-to-nemo-relay>" \
uv run pytest tests/e2e/test_codex.py -q
Set `FABRIC_TEST_CODEX_BIN="<path-to-codex>"` on either opt-in command to validate
an explicit app-server override instead of the SDK-pinned runtime.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@adapters/codex/README.md` around lines 156 - 162, Update the README command
examples to use quoted angle-bracketed placeholders for both executable paths:
replace the Nemo Relay and Codex path values with placeholders such as
“<path-to-nemo-relay>” and “<path-to-codex>”, keeping them inside the existing
shell assignments and code formatting.

Source: Coding guidelines


The SDK test uses the current Codex authentication state and exercises both the
single-invocation convenience API and multiple turns against one started
runtime. The Relay test additionally requires an external gateway binary and
verifies model responses, stable thread identity across turns, Agent Trajectory
Observability Format (ATOF), and Agent Trajectory Interchange Format (ATIF);
gateway startup alone is not a passing result. The semantic regression requires
the LLM request content to be decoded. It also requires ATIF to contain the
model, token usage, and expected agent response.
29 changes: 29 additions & 0 deletions adapters/codex/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# NVIDIA NeMo Fabric Codex Adapter

[![License](https://img.shields.io/github/license/NVIDIA/NeMo-Fabric)](https://github.com/NVIDIA/NeMo-Fabric/blob/main/LICENSE)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/NVIDIA/NeMo-Fabric/)
[![Release](https://img.shields.io/github/v/release/NVIDIA/NeMo-Fabric?color=green)](https://github.com/NVIDIA/NeMo-Fabric/releases)

![Diagram showing NeMo Fabric connecting applications, evaluations, and reinforcement learning rollouts to Hermes, Codex, Claude, and Deep Agents, with results, artifacts, and telemetry as outputs.](https://raw.githubusercontent.com/NVIDIA/NeMo-Fabric/refs/heads/main/assets/fabric-hero-option2.png)

Provides a NeMo Fabric adapter for use with [Codex](https://openai.com/codex/).

## Install

Installation can be performed using the `nemo-fabric` meta package with the `codex` extra, or by installing the adapter and harness packages separately. The following table shows which components each installation provides:

| Installation | Runtime | Adapter | Harness | NeMo Relay CLI |
| --- | --- | --- | --- | --- |
| `pip install "nemo-fabric[codex]"` | Yes | Yes | Yes | No |
| `pip install "nemo-fabric-adapters-codex[harness]"` | No | Yes | Yes | No |
| `pip install nemo-fabric-adapters-codex` | No | Yes | No | No |

The `full` extra is equivalent to `harness`. NeMo Relay is optional for ordinary
runs. NeMo Relay telemetry and streaming require the `nemo-relay` CLI tool to be installed, refer to the [NeMo Relay installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install#nemo-relay-cli).

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
6 changes: 4 additions & 2 deletions adapters/codex/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ classifiers = [
]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
readme = "pypi.md"
requires-python = ">=3.11"
dependencies = [
"nemo-fabric-adapters-common == 0.1.0",
Expand All @@ -38,7 +38,9 @@ full = [
]

[project.urls]
Repository = "https://github.com/NVIDIA/nemo-fabric/"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"

[tool.setuptools.packages.find]
Expand Down
28 changes: 0 additions & 28 deletions adapters/codex/testing.md
View file
Open in desktop

This file was deleted.

28 changes: 28 additions & 0 deletions adapters/common/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# NVIDIA NeMo Fabric Adapter Utilities

[![License](https://img.shields.io/github/license/NVIDIA/NeMo-Fabric)](https://github.com/NVIDIA/NeMo-Fabric/blob/main/LICENSE)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/NVIDIA/NeMo-Fabric/)
[![Release](https://img.shields.io/github/v/release/NVIDIA/NeMo-Fabric?color=green)](https://github.com/NVIDIA/NeMo-Fabric/releases)

![Diagram showing NeMo Fabric connecting applications, evaluations, and reinforcement learning rollouts to Hermes, Codex, Claude, and Deep Agents, with results, artifacts, and telemetry as outputs.](https://raw.githubusercontent.com/NVIDIA/NeMo-Fabric/refs/heads/main/assets/fabric-hero-option2.png)

`nemo-fabric-adapters-common` provides shared helper methods for NeMo Fabric
adapter implementations. Adapter packages typically declare this package as a
dependency.

## Install

Install the package directly when developing an adapter:

```bash
pip install nemo-fabric-adapters-common
```

Refer to the [NeMo Fabric documentation](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric)
for adapter and configuration guidance. Source code is available in the
[NVIDIA NeMo Fabric repository](https://github.com/NVIDIA/NeMo-Fabric).
6 changes: 4 additions & 2 deletions adapters/common/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ classifiers = [
]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
readme = "pypi.md"
requires-python = ">=3.11"

[project.urls]
Repository = "https://github.com/NVIDIA/nemo-fabric/"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"

[tool.setuptools.packages.find]
Expand Down
33 changes: 33 additions & 0 deletions adapters/deepagents/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# NVIDIA NeMo Fabric LangChain Deep Agents Adapter

[![License](https://img.shields.io/github/license/NVIDIA/NeMo-Fabric)](https://github.com/NVIDIA/NeMo-Fabric/blob/main/LICENSE)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/NVIDIA/NeMo-Fabric/)
[![Release](https://img.shields.io/github/v/release/NVIDIA/NeMo-Fabric?color=green)](https://github.com/NVIDIA/NeMo-Fabric/releases)

![Diagram showing NeMo Fabric connecting applications, evaluations, and reinforcement learning rollouts to Hermes, Codex, Claude, and Deep Agents, with results, artifacts, and telemetry as outputs.](https://raw.githubusercontent.com/NVIDIA/NeMo-Fabric/refs/heads/main/assets/fabric-hero-option2.png)

Provides a NeMo Fabric adapter for use with [LangChain Deep Agents](https://www.langchain.com/deep-agents).

## Install

Installation can be performed using the `nemo-fabric` meta package with the `deepagents` extra, or by installing the adapter and harness packages separately. The following table shows which components each installation provides:

| Installation | Runtime | Adapter | Harness | NeMo Relay Python Package |
| --- | --- | --- | --- | --- |
| `pip install "nemo-fabric[deepagents]"` | Yes | Yes | Yes | No |
| `pip install "nemo-fabric[deepagents,relay]"` | Yes | Yes | Yes | Yes |
| `pip install "nemo-fabric-adapters-deepagents[harness]"` | No | Yes | Yes | No |
| `pip install "nemo-fabric-adapters-deepagents[full]"` | No | Yes | Yes | Yes |
| `pip install "nemo-fabric-adapters-deepagents[relay]"` | No | Yes | No | Yes |
| `pip install nemo-fabric-adapters-deepagents` | No | Yes | No | No |

NeMo Relay is optional for ordinary runs. NeMo Relay telemetry and streaming
require one of the installations in the table that includes the NeMo Relay
Python package.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
6 changes: 4 additions & 2 deletions adapters/deepagents/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ classifiers = [
]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
readme = "pypi.md"
requires-python = ">=3.11"
dependencies = [
"nemo-fabric-adapters-common == 0.1.0",
Expand Down Expand Up @@ -50,7 +50,9 @@ full = [
]

[project.urls]
Repository = "https://github.com/NVIDIA/nemo-fabric/"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"

[tool.setuptools.packages.find]
Expand Down
34 changes: 34 additions & 0 deletions adapters/hermes/pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# NVIDIA NeMo Fabric Hermes Agent Adapter

[![License](https://img.shields.io/github/license/NVIDIA/NeMo-Fabric)](https://github.com/NVIDIA/NeMo-Fabric/blob/main/LICENSE)
[![GitHub](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/NVIDIA/NeMo-Fabric/)
[![Release](https://img.shields.io/github/v/release/NVIDIA/NeMo-Fabric?color=green)](https://github.com/NVIDIA/NeMo-Fabric/releases)

![Diagram showing NeMo Fabric connecting applications, evaluations, and reinforcement learning rollouts to Hermes, Codex, Claude, and Deep Agents, with results, artifacts, and telemetry as outputs.](https://raw.githubusercontent.com/NVIDIA/NeMo-Fabric/refs/heads/main/assets/fabric-hero-option2.png)

Provides a NeMo Fabric adapter for use with [Hermes Agent](https://hermes-agent.nousresearch.com/).

## Install

Hermes Agent and this adapter require Python versions 3.11 through 3.13.
Installation can be performed using the `nemo-fabric` meta package with the `hermes-agent` extra, or by installing the adapter and harness packages separately. The following table shows which components each installation provides:

| Installation | Runtime | Adapter | Harness | NeMo Relay Python Package |
| --- | --- | --- | --- | --- |
| `pip install "nemo-fabric[hermes-agent]"` | Yes | Yes | Yes | No |
| `pip install "nemo-fabric[hermes-agent,relay]"` | Yes | Yes | Yes | Yes |
| `pip install "nemo-fabric-adapters-hermes[harness]"` | No | Yes | Yes | No |
| `pip install "nemo-fabric-adapters-hermes[full]"` | No | Yes | Yes | Yes |
| `pip install "nemo-fabric-adapters-hermes[relay]"` | No | Yes | No | Yes |
| `pip install nemo-fabric-adapters-hermes` | No | Yes | No | No |

NeMo Relay is optional for ordinary runs. NeMo Relay telemetry and streaming
require one of the installations in the table that includes the NeMo Relay
Python package.

Refer to the [installation guide](https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric/getting-started/install) for more details.
6 changes: 4 additions & 2 deletions adapters/hermes/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ classifiers = [
]
license = "Apache-2.0"
license-files = ["LICENSE"]
readme = "README.md"
readme = "pypi.md"
# Hermes Agent does not currently support Python 3.14 or later.
requires-python = ">=3.11,<3.14"
dependencies = [
Expand All @@ -42,7 +42,9 @@ full = [
]

[project.urls]
Repository = "https://github.com/NVIDIA/nemo-fabric/"
Repository = "https://github.com/NVIDIA/NeMo-Fabric"
Homepage = "https://github.com/NVIDIA/NeMo-Fabric"
Issues = "https://github.com/NVIDIA/NeMo-Fabric/issues"
Documentation = "https://nvidia-nemo-fabric.docs.buildwithfern.com/nemo/fabric"

[tool.setuptools.packages.find]
Expand Down
Loading
Loading