| Name | fabrictestbed-extensions JSON |
| Version |
1.8.0
JSON |
| download |
| home_page | None |
| Summary | FABRIC Python Client Library and CLI Extensions |
| upload_time | 2025-01-10 17:43:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# fabrictestbed-extensions
[![pypi-badge]][pypy] [![api-docs-badge]][api-docs]
This is the implementation of a Python library, otherwise known as
"FABlib", for interacting with [FABRIC][fabric] testbed.
Your first encounter with FABlib might be through FABRIC project's
[JupyterHub instance][fabric-jupyter], 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][fabric-jupyter-examples] 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][fablib-install] and the notes below
for details.
FABlib API docs can be found [here][fablib-api-rtd]. 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:
```console
$ pip install fabrictestbed-extensions
```
If you need the current development version of FABlib, install it from
the git repository:
```console
$ 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:
```python
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.
<!-- URLs -->
[pypy]: https://pypi.org/project/fabrictestbed-extensions/
[pypi-badge]: https://img.shields.io/pypi/v/fabrictestbed-extensions (PyPI)
[api-docs]: https://fabric-fablib.readthedocs.io/en/latest/?badge=latest
[api-docs-badge]: https://readthedocs.org/projects/fabric-fablib/badge/?version=latest (Documentation Status)
[fabric]: https://fabric-testbed.net/
[forums]: https://learn.fabric-testbed.net/forums/
[fablib-api-rtd]: https://fabric-fablib.readthedocs.io/en/latest/
[venv]: https://docs.python.org/3/library/venv.html
[virtualenv]: https://virtualenv.pypa.io/en/latest/
[virtualenvwrapper]: https://virtualenvwrapper.readthedocs.io/en/latest/
[fabric-jupyter]: https://jupyter.fabric-testbed.net/
[fabric-jupyter-examples]: https://github.com/fabric-testbed/jupyter-examples
[fablib-install]: https://learn.fabric-testbed.net/knowledge-base/install-the-python-api/
[configuration]: https://fabric-fablib.readthedocs.io/en/latest/#configuring-fablib
[guidelines]: ./CONTRIBUTING.md
Raw data
{
"_id": null,
"home_page": null,
"name": "fabrictestbed-extensions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Paul Ruth <pruth@renci.org>, Komal Thareja <kthare10@renci.org>",
"download_url": "https://files.pythonhosted.org/packages/59/72/8a72662aef2523f8ece5622d7e33a561339dc9812ecbd12a6a5715c9451b/fabrictestbed_extensions-1.8.0.tar.gz",
"platform": null,
"description": "# fabrictestbed-extensions\n\n[![pypi-badge]][pypy] [![api-docs-badge]][api-docs]\n\nThis is the implementation of a Python library, otherwise known as\n\"FABlib\", for interacting with [FABRIC][fabric] testbed.\n\nYour first encounter with FABlib might be through FABRIC project's\n[JupyterHub instance][fabric-jupyter], where FABlib is pre-installed\nfor you. You will be presented with many examples of interacting with\nFABRIC testbed and FABlib usage when you log in there. Those [notebook\nsources][fabric-jupyter-examples] can be found on GitHub as well.\n\nIf you want to interact with FABRIC from Jupyter or a Python project\non your local development environment, that is possible too. See\n[Install the FABRIC Python API][fablib-install] and the notes below\nfor details.\n\nFABlib API docs can be found [here][fablib-api-rtd]. If you have\nquestions about FABRIC or FABlib usage, please ask them in FABRIC\n[forums].\n\n## Installing FABlib\n\nYou can install released versions of FABlib from PyPI:\n\n```console\n$ pip install fabrictestbed-extensions\n```\n\nIf you need the current development version of FABlib, install it from\nthe git repository:\n\n```console\n$ pip install git+https://github.com/fabric-testbed/fabrictestbed-extensions@main\n```\n\nNote that installing FABlib using either methods will also install a\nnumber of dependencies, so you might want to install FABlib in a\nvirtual environment. Your favorite tool for managing virtual\nenvironments ([venv], [virtualenv], or [virtualenvwrapper]) should\nwork. FABRIC team tends to favor virtualenvwrapper.\n\n\n## Using FABlib\n\nOnce installed, you can use FABlib in your Python projects:\n\n```python\nfrom fabrictestbed_extensions.fablib.fablib import FablibManager as fablib_manager\n\ntry:\n fablib = fablib_manager()\n fablib.show_config()\nexcept Exception as e:\n print(f\"Exception: {e}\")\n```\n\nPlease note that some [configuration] is required for this to work.\n\n## Contributing to FABlib\n\nWe welcome contributions in the form of bug reports, feature requests,\ncode patches, documentation updates, etc. If you have ideas that can\nhelp FABlib, please review the [guidelines] first.\n\n\n<!-- URLs -->\n\n[pypy]: https://pypi.org/project/fabrictestbed-extensions/\n[pypi-badge]: https://img.shields.io/pypi/v/fabrictestbed-extensions (PyPI)\n\n[api-docs]: https://fabric-fablib.readthedocs.io/en/latest/?badge=latest\n[api-docs-badge]: https://readthedocs.org/projects/fabric-fablib/badge/?version=latest (Documentation Status)\n\n[fabric]: https://fabric-testbed.net/\n[forums]: https://learn.fabric-testbed.net/forums/\n\n[fablib-api-rtd]: https://fabric-fablib.readthedocs.io/en/latest/\n\n[venv]: https://docs.python.org/3/library/venv.html\n[virtualenv]: https://virtualenv.pypa.io/en/latest/\n[virtualenvwrapper]: https://virtualenvwrapper.readthedocs.io/en/latest/\n\n[fabric-jupyter]: https://jupyter.fabric-testbed.net/\n[fabric-jupyter-examples]: https://github.com/fabric-testbed/jupyter-examples\n[fablib-install]: https://learn.fabric-testbed.net/knowledge-base/install-the-python-api/\n\n[configuration]: https://fabric-fablib.readthedocs.io/en/latest/#configuring-fablib\n\n[guidelines]: ./CONTRIBUTING.md\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "FABRIC Python Client Library and CLI Extensions",
"version": "1.8.0",
"project_urls": {
"ChangeLog": "https://github.com/fabric-testbed/fabrictestbed-extensions/blob/main/CHANGELOG.md",
"Documentation": "https://fabric-fablib.readthedocs.io/",
"Homepage": "https://fabric-testbed.net/",
"Sources": "https://github.com/fabric-testbed/fabrictestbed-extensions"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "069ca179ba2e9ebc6c601fd22dcaa5a9a520520199b47f0899680fa4e256c2c4",
"md5": "3b994bbb6fa8625651a34cf2dfe2c921",
"sha256": "9e3b28a99a4ead8a173993ce98d51e4a37ab3a6cf2c9bb161640af20bb155ccf"
},
"downloads": -1,
"filename": "fabrictestbed_extensions-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b994bbb6fa8625651a34cf2dfe2c921",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 419397,
"upload_time": "2025-01-10T17:43:00",
"upload_time_iso_8601": "2025-01-10T17:43:00.124517Z",
"url": "https://files.pythonhosted.org/packages/06/9c/a179ba2e9ebc6c601fd22dcaa5a9a520520199b47f0899680fa4e256c2c4/fabrictestbed_extensions-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "59728a72662aef2523f8ece5622d7e33a561339dc9812ecbd12a6a5715c9451b",
"md5": "d806435ac8b5ae48c083942934fa8cc8",
"sha256": "c9d3306f97971547384ef958959504aa51584e136e72fbbce8a67b7dea22da60"
},
"downloads": -1,
"filename": "fabrictestbed_extensions-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "d806435ac8b5ae48c083942934fa8cc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 438081,
"upload_time": "2025-01-10T17:43:03",
"upload_time_iso_8601": "2025-01-10T17:43:03.104742Z",
"url": "https://files.pythonhosted.org/packages/59/72/8a72662aef2523f8ece5622d7e33a561339dc9812ecbd12a6a5715c9451b/fabrictestbed_extensions-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-10 17:43:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fabric-testbed",
"github_project": "fabrictestbed-extensions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fabrictestbed-extensions"
}
