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.0rc0.tar.gz (393.1 kB view details)

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.0rc0-py3-none-any.whl (369.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.0rc0.tar.gz
Algorithm Hash digest
SHA256 8808b90e4678e774eead8a6529b4ab49ad711fcef8ebba24754eee86e95f6de4
MD5 b485d081370601fe1820069450ad66a6
BLAKE2b-256 5f5b9de3c4b7c5d6f71c5bb4cf72cd598665b84d99336ca3bc40e233b6503335

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.0rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f9a9d65974ba0214b29715410bf98327ea637c0a5048fcc4aadfde7a933dbed
MD5 244b3f632c27564b525fd63681c96d18
BLAKE2b-256 631f40299b8f2b23454f3f4df993f1035b5f7c0bb2e9692bb863ce841fbb3ca7

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