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

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.7.0-py3-none-any.whl (400.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.7.0.tar.gz
Algorithm Hash digest
SHA256 5612c9d7b1f116e6b86fdbaf023f694e0d6dfc0e66bbd1ae9a921d7d9d6d3484
MD5 d9c15a5d84b5e47bec89199d5e65fa07
BLAKE2b-256 e510d40a69125bac9a7f6f501e806ae88390bc08c9ffe29af301bbfa26fe882a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0096eac307afee98c4e18de150896eab0de9a2bb68b7b08b0bbd605fc46f91c4
MD5 3903abb62269495a20df35151c87bf0f
BLAKE2b-256 6dd17f27282b9018c1a72bb179c7f2af6e9790056a68f79e28fa6fbcc97f1ccb

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