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

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.3-py3-none-any.whl (381.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.3.tar.gz
Algorithm Hash digest
SHA256 e48ceeec0f751124225fb78f1f7f1d08d12f5fe0868e69ede265d9aa1331fa65
MD5 f3a98850807e1876c4c11ac32c8188b2
BLAKE2b-256 df98ef89c3d705f2e13dd12844c3c194492a25a8f02bfc51bd0d442f68cd406c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1e3ba654e771565454d4f194769a5ac109e4e82829dbb40dca0898f3b34f2af5
MD5 9735996a7c627dd52af0b00e007bcf2d
BLAKE2b-256 6b6bbc0e2dd2e021c4d2c8413151c25f1d356d60dd306a137ea29a1a6a94275c

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