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.2.tar.gz (421.6 kB view details)

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.7.2-py3-none-any.whl (400.8 kB view details)

Uploaded Python 3

File details

Details for the file fabrictestbed-extensions-1.7.2.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.7.2.tar.gz
Algorithm Hash digest
SHA256 bfad8cc9c22148d9099fdf3bf471f1e75bb44b14f03f430202dc150b9ebe5908
MD5 514687942f1511394890db0628fddf50
BLAKE2b-256 a1040c019af7e267aafacc0485096b1bafc17973e5323a0bf65b4392dcac0a6e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5a13c0f24bcd0164a88d05808f8d4eca6af1710d12fe26160589e3e21660e54
MD5 71530d71e08c6d74b2241a8506975002
BLAKE2b-256 5531932604b552d332c783673a6e764e2586a5dd45a234c1eab91ef912c65c93

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