Skip to main content

FABRIC Python Client Library and CLI Extensions

Project description

fabrictestbed-extensions

pypi-badge api-docs-badge

This repository contains implementation of a Python API, otherwise known as "FABlib", for intereacting with FABRIC testbed.

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}")

Your first encounter with FABlib however might be through FABRIC project's JupyterHub instance. You will be presented with many examples on FABlib usage when you log in there. The notebook sources can be found on GitHub as well.

Since FABlib 1.4, API docs can be found here. Older API docs are here.

If you want to interact with FABRIC from Jupyter installed on your computer, see: Install the FABRIC Python API.

Contributing to FABlib

Contributions to FABlib are made with GitHub Pull Requests. When you submit a pull request, some tests will run against it:

  • Code formatting will be checked using black and isort. Be sure that your code is formatted with these tools.
  • Unit tests will be run.
  • Packages will be built.
  • CHANGELOG.md will be checked for updates.

Testing FABlib

FABlib currently has a modest set of unit and integration tests, under the top-level tests directory. Unit tests can be run like so, using tox:

$ pip install -e .[test]
$ tox

Integration tests can be run like so:

$ tox -e integration

Tox attempts to run tests in an isolated virtual environment. If you want to run some tests directly using pytest, that is possible too:

$ pytest -s tests/integration/test_hello_fabric.py

Packaging FABlib

FABlib uses flit as the build backend. To build source and wheel packages, do this:

$ pip install flit
$ flit build

While using flit as the build backend, continuing to use build as the build frontend should work too:

$ pip install build
$ python -m build

Releasing FABlib

When it is time to release a new version of FABlib, remember to: (1) update the package version in top-level __init__.py, (2) build the source and wheel packages, and (3) upload packages to PyPI:

$ flit publish

Continuing to use twine to publish packages is an option too:

$ twine upload dist/*

For details about publishing to PyPI, see flit documentation about package uploads.

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.0b9.tar.gz (381.5 kB view details)

Uploaded Source

Built Distribution

fabrictestbed_extensions-1.6.0b9-py3-none-any.whl (361.1 kB view details)

Uploaded Python 3

File details

Details for the file fabrictestbed-extensions-1.6.0b9.tar.gz.

File metadata

File hashes

Hashes for fabrictestbed-extensions-1.6.0b9.tar.gz
Algorithm Hash digest
SHA256 f5e01606982544d512154f8e60df729964f17043c12e03bab240e605d627c57b
MD5 68bf4029516e77b80514cc24bcee4be3
BLAKE2b-256 92ce43f12921e3753f7c701acdea7bee3a8666deb7a4d98b07e7bb99c380252f

See more details on using hashes here.

File details

Details for the file fabrictestbed_extensions-1.6.0b9-py3-none-any.whl.

File metadata

File hashes

Hashes for fabrictestbed_extensions-1.6.0b9-py3-none-any.whl
Algorithm Hash digest
SHA256 c96ebcb30ecec9a1fa11880723142d634789860f7f0d3395cbf2b692c49c3cbb
MD5 cb7fbb0261ee3351eeea64fe62552655
BLAKE2b-256 21daf3f6463eb11905fa7e45dc682b7ab6f187e46a4acf0ab73a6cc30be316df

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