search

robots-from-jupyter / robotframework-jupyterlibrary

A Robot Framework library for testing Jupyter end-user applications and extensions
https://robotframework-jupyterlibrary.rtfd.io
BSD 3-Clause "New" or "Revised" License
22 stars 9 forks source link
acceptance-testing binder jupyter jupyterlab notebooks robotframework rpa screenshots selenium

readme

robotframework-jupyterlibrary

A Robot Framework library for automating (testing of) Jupyter end-user applications and extensions

pip conda docs demo actions
pip-badge [![conda-forge-badge]][conda-forge] ![docs-badge] [binder-badge][binder] [![workflow-badge]][workflow]

Using

Write .robot files that use JupyterLibrary keywords... or use magics in notebooks.

*** 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

pip install robotframework-jupyterlibrary

Or

mamba install -c conda-forge robotframework-jupyterlibrary

Or (if you must):

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:

Some of its testing approaches (only distribtued in source form, not e.g. wheels) are also derived from other tools:

[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

[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

[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

[contributing]: https://github.com/robots-from-jupyter/robotframework-jupyterlibrary/blob/main/CONTRIBUTING.md