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/

Requirements

Python 3.10 or newer.

Licence

MIT.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

forward_sdk-0.1.5.tar.gz (499.4 kB view details)

Uploaded Sep 9, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

forward_sdk-0.1.5-py3-none-any.whl (252.6 kB view details)

Uploaded Sep 9, 2026 Python 3

File details

Details for the file forward_sdk-0.1.5.tar.gz.

File metadata

Download URL: forward_sdk-0.1.5.tar.gz
Upload date: Sep 9, 2026
Size: 499.4 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for forward_sdk-0.1.5.tar.gz
Algorithm	Hash digest
SHA256	`52c225726e23e1025e08af409502abc4afd279f591e636b937356430e10c8d5d`
MD5	`54aa1c3331c58d3014c832891cc2db10`
BLAKE2b-256	`1ea591e1d051b6aface13b0e147b16bbd01a11313b1352807246bd6a7ab70a36`

See more details on using hashes here.

Provenance

The following attestation bundles were made for forward_sdk-0.1.5.tar.gz:

Publisher: release.yml on forwardnetworks/forward-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: forward_sdk-0.1.5.tar.gz
- Subject digest: 52c225726e23e1025e08af409502abc4afd279f591e636b937356430e10c8d5d
- Sigstore transparency entry: 2771009331
- Sigstore integration time: Sep 9, 2026
Source repository:
- Permalink: forwardnetworks/forward-python-sdk@ccec1a263f4fcd793af7b7a46dd67346c081f57a
- Branch / Tag: refs/tags/v0.1.5
- Owner: https://github.com/forwardnetworks
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@ccec1a263f4fcd793af7b7a46dd67346c081f57a
- Trigger Event: push