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

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.1b0-py3-none-any.whl (376.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.1b0.tar.gz
Algorithm Hash digest
SHA256 ab68a9cc6c4d321245bd86b70d0685c26442a9df6794a23aef3af2e3f78a25b0
MD5 dfcda59eeb39f40b146aa374965d6474
BLAKE2b-256 646f5c47ddc1b6067657cdd2f8b5a2123fa328e95bf0a9478142d3be9fa4abb2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba7cb8fa355386a93ef123fe89b2e115e1875f6ed979f7d4d1906163804eb1f6
MD5 1a99ef6e7ac9162a2a388fa93ec2d348
BLAKE2b-256 27e9688dbce43fc8047fae8415597e97d56c697d6edfca5d5413cdd22a901d40

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