FABRIC Measurement Framework Python Client Library - Makes monitoring FABRIC Slice easy.
Project description
MFLIB Measurement Framework Library
Welcome to the FABRIC Measurement Framework Library. MFLib makes it easy to install monitoring systems to a FABRIC experimenter's slice. The monitoring system makes extensive use of industry standards such as Prometheus, Grafana, Elastic Search and Kibana while adding customized monitoring tools and dashboards for quick setup and visualization.
Documentation Resources
For more information about FABRIC vist fabric-testbed.net
Example Jupyter Notebooks
FABRIC Jupyter Examples GitHub repository contains many examples for using FABRIC from simple slice setup to advanced networking setups. Look for the MFLib section. These notebooks are designed to be easily used on the FABRIC JupyterHub
FABRIC Learn Site
MFLib Python Package Documentation
Documentation for the package is presented in serveral different forms (and maybe include later in this document):
- ReadTheDocs
- MFLib.pdf in the source code/GitHub.
- MFLib HTML Index in the source code/GitHub.
- Or you may build the documentation from the source code. See Sphinx Documentation later in this document.
MFLib Installation
Instaling via PIP
MFLib may be installed using PIP and PyPI fabrictestbed-mflib
pip install --user fabrictestbed-mflib
Installing via Source Code
If you need a development version, clone the git repo, then use pip to install.
git clone https://github.com/fabric-testbed/mflib.git
cd mflib
pip install --user .
Building & Deploying
Spinx Documentation
This package is documented using sphinx. The source
directories are already created and populated with reStructuredText ( .rst ) files. The build
directories are deleted and/or are not included in the repository,
API documentation can also be found at https://fabrictestbed-mflib.readthedocs.io/.
Build HTML Documents
Install the extra packages required to build API docs: (sphinx, furo theme, and myst-parser for parsing markdown files):
pip install -r docs/requirements.txt
Build the documentation by running the following command from the root directory of the repo.
sphinx-build -b html docs/source/ docs/build/html
The completed documentation may be accessed by clicking on /docs/build/html/index.html
Build PDF Document
Latex must be installed. For Debian use:
sudo apt install texlive-latex-extra
sudo apt install latexmk
Run the bash script to create the MFLIB.pdf documentation. MFLIB.pdf will be placed in the root directory of the repository.
./create_pdf_doc.sh
Distribution Package
MFLib package is created using Flit Be sure to create and commit the PDF documentation to GitHub before building and publishing to PyPi. The MFLib.pdf is included in the distributition.
python3 -m pip install flit
To build python package for PyPi run
flit build
Uploading to PyPI
First test the package by uploading to test.pypi.org then test the install.
flit publish --repository testpypi
Once install is good, upload to PiPy
flit publish --repository pypi
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
Built Distribution
Hashes for fabrictestbed-mflib-0.1.0b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ce7d00a8f47ed5193cafa955d8befa0719b73d6e3869ba4f2106972af3b34ea |
|
MD5 | 080e341795631ccb75084ae3ba2e361c |
|
BLAKE2b-256 | 619efe55a92110d60a79d056e5f31e49265f39d3acfd17eda0883518aa135698 |
Hashes for fabrictestbed_mflib-0.1.0b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe11b6f6e2b39d3fb52c7f9e804f11bd6506da996f5ba6a5a255707ce89257fa |
|
MD5 | 15a7121274cd7d9636653a28dcf9b417 |
|
BLAKE2b-256 | 5fd64937063ac90192bd52403cfa467ba2acee16d6da958eb8eb564578901e6a |