forward-sdk
Python SDK for the Forward Networks REST API.
A Forward Networks Field Integration. Built and maintained by the field team to make integration work easier. It is not a supported Forward Networks product: it carries no SLA, and issues are handled on a best-effort basis rather than through Forward Support.
Status: pre-release. The public API is not yet stable.
pip install forward-sdk
from forward_sdk import ForwardClient
with ForwardClient.from_env() as client:
for network in client.networks.list():
print(network.id, network.name)
rows = client.nqe.query(
"foreach device in network.devices select {name: device.name}",
network_id="101",
)
Authentication is HTTP basic with an API token: its access key is the username and its secret is the password.
What it covers
Every operation in Forward's API. The groups integrations use most -- NQE, snapshots, networks, devices and device tags -- are hand-written with curated names and behaviour such as waiting for a snapshot to finish processing. The rest are generated from the OpenAPI description Forward produces from its own server code.
Both a synchronous and an asynchronous client, with identical surfaces.
Notable
NQE first. Running a query, paging or streaming the results, diffing a query across snapshots, and publishing queries to the library are all first-class. Paging carries guard rails for the ways it can go wrong in production: a result set that ends early, a server that stops advancing, a query far larger than expected.
Typed, but tolerant. Responses are pydantic models. Unknown fields and
unknown enum values are preserved rather than rejected, so a Forward release
that adds either does not break an older SDK. NQE rows stay dict[str, Any],
because a query's columns are defined by the query.
Honest about refusals. A missing licence, a feature absent from your deployment, and a role-based denial all arrive as the same status codes, so the SDK does not pretend to tell them apart. It gives you Forward's own explanation and a documented hint about what gates that operation.
Documentation
https://forwardnetworks.github.io/forward-python-sdk/
- Quickstart
- Configuration
- NQE guide
- Availability and gating
- Migrating from the NetBox plugin or the Nautobot plugin
Requirements
Python 3.10 or newer.
Licence
MIT.
1 maintainer
Metadata
1 maintainer
Release files for forward-sdk 0.1.26
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| forward_sdk-0.1.26.tar.gz | 1.0 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| forward_sdk-0.1.26-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / forward_sdk-0.1.26.tar.gz
| Download URL | forward_sdk-0.1.26.tar.gz |
|---|---|
| Size | 1.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e53d3b9518f26b6ba43c21c39af050a15a0043aefb09c43d4c10e0bd1fbb2a42
|
|
BLAKE2b-256 checksum How to use checksums |
4d6dfb44ac824aeff31281e9928d961ec80e6c1ad8c66cbaab7ab6000604e76e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logRelease files / forward_sdk-0.1.26-py3-none-any.whl
| Download URL | forward_sdk-0.1.26-py3-none-any.whl |
|---|---|
| Size | 519.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c74ac08472e577df191b60f48e47790f6f1f415f448dd6aeb10d91a714ebf2da
|
|
BLAKE2b-256 checksum How to use checksums |
2813f7f9a2e79ef49f00d83c562878f94708be3a47c2b2c4925caef99f785fa3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logSecurity for forward-sdk 0.1.26
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for forward_sdk-0.1.26.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
