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

This version

1.6.4

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

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.4-py3-none-any.whl (382.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.4.tar.gz
Algorithm Hash digest
SHA256 ca05a280d4cba0fc164db84e7a554bf05f315509a8a14d6768ba8d84247b1485
MD5 df10fe07f734c2493d1891004a90f4e3
BLAKE2b-256 e52ff6e7dee0fd80e7575206c004d378fa6bdd5c46599535375a1c3d792c5795

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bf88613d0610b31a675136161104a2ef1bfa7ee54f4750dccd8f2fb3a8c6a22f
MD5 b610d134d0c905b0d68a4c5d669a94d7
BLAKE2b-256 97a78a72ec501bc3a364fb2e1c2988ce8397c31c155a0ccbd9efcb262c2c97b4

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