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

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.4b0.tar.gz (423.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file fabrictestbed-extensions-1.7.4b0.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.7.4b0.tar.gz
Algorithm Hash digest
SHA256 31ce649895f431e26eb597c068855fecb8796ee3b9584486ea9d1b30e5056690
MD5 2d789b65dd1f38fed41dadb1ba7f74bc
BLAKE2b-256 f47602c1130d5b231133fadf8d3b1133ac88c5f23a19c70fad8c2e0fe171a058

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.4b0-py3-none-any.whl
Algorithm Hash digest
SHA256 2607471fb58800bd0e5fbe6ab81928c581972de6dac5e4905efb21f6871a2fea
MD5 d89962e1e3864fe096632c30604e6c50
BLAKE2b-256 e2b2423bc80b8edf91f0032f848d2e56120441fb2e5e7efbe76411a48683103a

See more details on using hashes here.

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