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.1b1.tar.gz (397.5 kB view details)

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.1b1-py3-none-any.whl (378.5 kB view details)

Uploaded Python 3

File details

Details for the file fabrictestbed-extensions-1.6.1b1.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.1b1.tar.gz
Algorithm Hash digest
SHA256 167290289fa616f96ec40b4b93291c1890d8d8f0b0adbc155613e1fe405a8448
MD5 5e01ee034473c2b5023cdf81240c7c1a
BLAKE2b-256 5a4d8cf7bfdc57e3c7800e64d88d3c1aafe3de493ceea3d219f323cb8361c7c0

See more details on using hashes here.

File details

Details for the file fabrictestbed_extensions-1.6.1b1-py3-none-any.whl.

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.1b1-py3-none-any.whl
Algorithm Hash digest
SHA256 e08ca9b8d5d3a0a227e68a010ad6aa9d205e5ee12928f31153fe033aa269e987
MD5 829623ef9658ef0544030b8bddde8b0d
BLAKE2b-256 4dc9947458064a400a9afe4b6d8d5246014b3d9c594dac12f7944a53044c2ff3

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