Skip to main content

FABRIC Python Client Library and CLI Extensions

Project description

fabrictestbed-extensions

pypi-badge api-docs-badge

This is the implementation of a Python library, otherwise known as "FABlib", for interacting with FABRIC testbed.

Your first encounter with FABlib might be through FABRIC project's JupyterHub instance, where FABlib is pre-installed for you. You will be presented with many examples of interacting with FABRIC testbed and FABlib usage when you log in there. Those notebook sources can be found on GitHub as well.

If you want to interact with FABRIC from Jupyter or a Python project on your local development environment, that is possible too. See Install the FABRIC Python API and the notes below for details.

FABlib API docs can be found here. If you have questions about FABRIC or FABlib usage, please ask them in FABRIC forums.

Installing FABlib

You can install released versions of FABlib from PyPI:

$ pip install fabrictestbed-extensions

If you need the current development version of FABlib, install it from the git repository:

$ pip install git+https://github.com/fabric-testbed/fabrictestbed-extensions@main

Note that installing FABlib using either methods will also install a number of dependencies, so you might want to install FABlib in a virtual environment. Your favorite tool for managing virtual environments (venv, virtualenv, or virtualenvwrapper) should work. FABRIC team tends to favor virtualenvwrapper.

Using FABlib

Once installed, you can use FABlib in your Python projects:

from fabrictestbed_extensions.fablib.fablib import FablibManager as fablib_manager

try:
    fablib = fablib_manager()
    fablib.show_config()
except Exception as e:
    print(f"Exception: {e}")

Please note that some configuration is required for this to work.

Contributing to FABlib

We welcome contributions in the form of bug reports, feature requests, code patches, documentation updates, etc. If you have ideas that can help FABlib, please review the guidelines first.

Project details


Release history Release notifications | RSS feed

This version

1.7.4

Download files

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

Source Distribution

fabrictestbed_extensions-1.7.4.tar.gz (437.8 kB view details)

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.7.4-py3-none-any.whl (419.2 kB view details)

Uploaded Python 3

File details

Details for the file fabrictestbed_extensions-1.7.4.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.4.tar.gz
Algorithm Hash digest
SHA256 db61a5effd3ab1fea4048cf43aad0cfc4bcf45bfc0602b46cbe982a5d7944ed2
MD5 7b68c565fab5b2d8723a7488c6bd144c
BLAKE2b-256 73626119c05222a59825ee3fa93e3778ff139891c1a7b8da50359e23de24a947

See more details on using hashes here.

Provenance

The following attestation bundles were made for fabrictestbed_extensions-1.7.4.tar.gz:

Publisher: publish.yml on fabric-testbed/fabrictestbed-extensions

Attestations:

File details

Details for the file fabrictestbed_extensions-1.7.4-py3-none-any.whl.

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 61bc3be977b631f9a89c0854cf80ed05ce5619f7792e19cc2d53d0efb2c01ce6
MD5 b336b155424707697c4dc68ca049e86b
BLAKE2b-256 067fb3af2abfebe0bb1833a1614b701edfba5c8514b8ce7e2ebf59639a9c63c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for fabrictestbed_extensions-1.7.4-py3-none-any.whl:

Publisher: publish.yml on fabric-testbed/fabrictestbed-extensions

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page