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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file fabrictestbed-extensions-1.6.3b2.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.3b2.tar.gz
Algorithm Hash digest
SHA256 8996c495f9ae55a9bf9a7e0753ce6fe333fd20a0c8036b95c1d7a7b84982189e
MD5 0b82567ed6068956a83247a097f8b120
BLAKE2b-256 3089eb0a324db87daa125c3d06e879ec1b1842f5134df9fb0dea39cb3f60f296

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.3b2-py3-none-any.whl
Algorithm Hash digest
SHA256 6e339463eea142d74fbc7f2cf380c7374c950def1db3fb1dbe925d187f92334c
MD5 bd99a96b9eb8498baffdbcf0c3f18dc1
BLAKE2b-256 78e59ab96be85933371db5b1e221c743cacdeb5eb4fddfbbb35c5edea569c20d

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