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

This version

1.7.3

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.3.tar.gz
Algorithm Hash digest
SHA256 4b89c675aabb7082cea1bd3cedecb5901f1757578cbcbb5c5468eb0f1df7d235
MD5 333128f1fee074378238ddbc5a7e905a
BLAKE2b-256 b80480736af1c530b944feea864e7c00f5c0fc95d6fd0975ec20c666ff4fb4da

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 887a5903d18a3b85ffa37ccf21bb5e0f1904e63e36e8fa1da754dfaab49e5bd2
MD5 1980a997f45e31da3bdc050a3696ea59
BLAKE2b-256 942e8bdbc16643784622076085c36b38be8e4e26c53b24ef325e5c962ca9dab0

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