Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary
A Robot Framework library for testing Jupyter end-user applications and extensions
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary
acceptance-testing binder jupyter jupyterlab notebooks robotframework rpa screenshots selenium
Last synced: 13 days ago
JSON representation
A Robot Framework library for testing Jupyter end-user applications and extensions
- Host: GitHub
- URL: https://github.com/robots-from-jupyter/robotframework-jupyterlibrary
- Owner: robots-from-jupyter
- License: bsd-3-clause
- Created: 2018-12-03T05:32:06.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T22:14:34.000Z (5 months ago)
- Last Synced: 2025-01-16T10:24:11.915Z (20 days ago)
- Topics: acceptance-testing, binder, jupyter, jupyterlab, notebooks, robotframework, rpa, screenshots, selenium
- Language: Python
- Homepage: https://robotframework-jupyterlibrary.rtfd.io
- Size: 890 KB
- Stars: 22
- Watchers: 2
- Forks: 9
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# robotframework-jupyterlibrary
> A [Robot Framework] library for automating (testing of) [Jupyter] end-user
> applications and extensions
[robot framework]: http://robotframework.org
[jupyter]: https://jupyter.org
| pip | conda | docs | demo | actions |
| :-----------------: | :---------------------------------: | :-------------------: | :-----------------------: | :---------------------------: |
| [![pip-badge]][pip] | [![conda-forge-badge]][conda-forge] | [![docs-badge]][docs] | [![binder-badge]][binder] | [![workflow-badge]][workflow] |
## Using
Write `.robot` files that use `JupyterLibrary` [keywords]... or use [magics] in
notebooks.
```robotframework
*** Settings ***
Library JupyterLibrary
Suite Setup Wait For New Jupyter Server To Be Ready jupyter-lab
Test Teardown Reset JupyterLab And Close
Suite Teardown Terminate All Jupyter Servers
*** Test Cases ***
A Notebook in JupyterLab
Open JupyterLab
Launch A New JupyterLab Document
Add And Run JupyterLab Code Cell
Wait Until JupyterLab Kernel Is Idle
Capture Page Screenshot
```
See the [acceptance tests] for examples.
## Installation
```bash
pip install robotframework-jupyterlibrary
```
Or
```bash
mamba install -c conda-forge robotframework-jupyterlibrary
```
Or (if you must):
```bash
conda install -c conda-forge robotframework-jupyterlibrary
```
Or see the [contributing guide][contributing] for a development install.
## Free Software
JupyterLibrary is Free Software under the [BSD-3-Clause License][license]. It contains
code from a number of other projects:
- [Jyve] ([BSD-3-Clause][jyve-license])
- Initial implementations of robot keywords
Some of its testing approaches (only distribtued in source form, not e.g. wheels) are
also derived from other tools:
- [ipyforcegraph][ipfg] ([BSD-3-Clause][ipfg-license])
- Initial implementation of [kernel-under-test coverage][kernel-cov] instrumentation
[license]:
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/blob/main/LICENSE
[acceptance tests]:
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/tree/main/atest
[miniforge]: https://github.com/conda-forge/miniforge/releases
[binder-badge]: https://mybinder.org/badge_logo.svg
[binder]:
https://mybinder.org/v2/gh/robots-from-jupyter/robotframework-jupyterlibrary/main?urlpath=lab/tree/docs/MAGIC.ipynb
[workflow-badge]:
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/workflows/CI/badge.svg
[workflow]:
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/actions?query=workflow%3ACI+branch%3Amain
[docs-badge]:
https://readthedocs.org/projects/robotframework-jupyterlibrary/badge/?version=stable
[pip-badge]: https://img.shields.io/pypi/v/robotframework-jupyterlibrary.svg
[pip]: https://pypi.org/project/robotframework-jupyterlibrary
[conda-forge]:
https://github.com/conda-forge/robotframework-jupyterlibrary-feedstock#installing-robotframework-jupyterlibrary
[conda-forge-badge]:
https://img.shields.io/conda/vn/conda-forge/robotframework-jupyterlibrary.svg
[docs]: https://robotframework-jupyterlibrary.readthedocs.io
[ipfg]: https://github.com/jupyrdf/ipyforcegraph
[ipfg-license]: https://github.com/jupyrdf/ipyforcegraph/blob/main/LICENSE.txt
[jyve]: https://github.com/deathbeds/jyve
[jyve-license]: https://github.com/deathbeds/jyve/blob/master/LICENSE
[kernel-cov]: https://github.com/jupyrdf/ipyforcegraph/pull/89
[magics]: https://robotframework-jupyterlibrary.readthedocs.io/en/stable/MAGIC.html
[keywords]: https://robotframework-jupyterlibrary.readthedocs.io/en/stable/KEYWORDS.html
[contributing]:
https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/blob/main/CONTRIBUTING.md