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 intereacting 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.6.0rc2.tar.gz (392.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file fabrictestbed-extensions-1.6.0rc2.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.0rc2.tar.gz
Algorithm Hash digest
SHA256 3d83bc4b7cde2b4710c3ee09c3ce0379811c58926f6ab4ef5e5af610d2d4620a
MD5 c556c4a040f155a01c80f2a2b596ba5f
BLAKE2b-256 ca0033bff15c78c36493100e80b2339a4783b467ae80d27dac7b5f1770e3a57e

See more details on using hashes here.

File details

Details for the file fabrictestbed_extensions-1.6.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 6f21645e04e2d8c7130d51bed2084e82479759628f2e5f3a854523bb1e79a64c
MD5 bf8df309d0086cbffbb4bb7d1cd4181d
BLAKE2b-256 1e4cacdd8fa16bff4ebcb2348b75ad3b72ca1a3b2d82b9669af75d2649991d81

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