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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.5.6rc0.tar.gz
Algorithm Hash digest
SHA256 f0d307b4d5317f3ae145d71b0ab1a45f5dcebdc7cde2a6d324df31a6984e766f
MD5 21ce4302cbc0512ae38eb9d82f4f0d46
BLAKE2b-256 c351440d083e4178c8b6f571324b36566ec0b5d0ce0b3705156e720534d71c5c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.5.6rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7b2d87b5c153d2ee8a5af052dc61bcb5d238e9ea764498872553f2cac6896cd
MD5 226ec7e02f9ee40e8fffd88b6ccbd27e
BLAKE2b-256 97437017ae5023cfda547ff08bee009dc0c9daae098c200000f5d16b8a9d27f3

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