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.5.6

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

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.5.6-py3-none-any.whl (369.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.5.6.tar.gz
Algorithm Hash digest
SHA256 61e823493b6dd6a42d9002850b6c30bde4624273b78e3e285a23eb90bbb9300d
MD5 23a86301d83063431eeb9507a315dddf
BLAKE2b-256 f973a2c31fd33a90f9d57cef90e7b972e3cbb9068d501f44cf23fffeec51f288

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a12147a6244cf01b2f1219c5dc0dd34852074a39cb4ab95f7b0a2c942199941d
MD5 aed4bc87c7da9fecbe14ae3529f75f6b
BLAKE2b-256 0836e7f804400866b8a634aaa493dfeaffe1fb66ca08462a95389dc0ab7017b5

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