Skip to main content

Python client for Gnetcli GRPC server

Gnetcli provides a universal way to execute arbitrary commands using a CLI, eliminating the need for screen scraping with expect.

See documentation on gnetcli server.

Example:

from gnetclisdk.client import Credentials, Gnetcli, HostParams
import os, asyncio

async def example():
    api = Gnetcli(insecure_grpc=True)
    # api = Gnetcli(insecure_grpc=True, auth_token="Basic " + base64.b64encode(f"{username}:{password}".encode('utf-8')).decode("ascii")
    dev_creds = Credentials(os.environ.get("LOGIN"), os.environ.get("PASSWORD"))
    res = await api.cmd(hostname="myhost", cmd="dis clock", host_params=HostParams(device="huawei", credentials=dev_creds))
    print("err=%s status=%s out=%s" % (res.error, res.status, res.out))

asyncio.run(example())

Output:

err=b'' status=0 out=b'2023-11-10 09:31:58\nFriday\nTime Zone(UTC) : UTC'

Tests

From this directory, with Go on PATH (to build gnetcli_server and gswitch):

python3 -m venv .venv && . .venv/bin/activate
pip install -r requirements.txt -r requirements-test.txt -e .
pytest tests/

Optional: GNETCLI_TEST_PREBUILT_DIR — directory that already contains gnetcli_server and gswitch binaries (skip go build in tests).

Download files

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

Source Distribution

gnetclisdk-1.3.9.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

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

gnetclisdk-1.3.9-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file gnetclisdk-1.3.9.tar.gz.

File metadata

  • Download URL: gnetclisdk-1.3.9.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for gnetclisdk-1.3.9.tar.gz
Algorithm Hash digest
SHA256 7f8c4bb271ec59389d63ffa3c0f4f40b49a07320ab8a44a765facf47813979e5
MD5 1bb306e98bc0f93f0702ab30e07abd31
BLAKE2b-256 4b74f2ec35f822845d00ced33dea8ab1d00167f5824e07041372cf24e083226a

See more details on using hashes here.

Provenance

The following attestation bundles were made for gnetclisdk-1.3.9.tar.gz:

Publisher: publish-to-pypi.yml on annetutil/gnetcli

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

File details

Details for the file gnetclisdk-1.3.9-py3-none-any.whl.

File metadata

  • Download URL: gnetclisdk-1.3.9-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for gnetclisdk-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 598ce9c72686ff034b365ebff15d5c9a250a7af65518b12ca6f20fa8ff64090a
MD5 e6503f4807efdb63e4586770b5892be0
BLAKE2b-256 92db2bb69ffaa2ea36a7457620ad5c04ec75623ab567d8175aa7843e28f5c070

See more details on using hashes here.

Provenance

The following attestation bundles were made for gnetclisdk-1.3.9-py3-none-any.whl:

Publisher: publish-to-pypi.yml on annetutil/gnetcli

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

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page