New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket
Book a DemoSign in

robotkernel

Package Overview
Dependencies
Maintainers
1
Versions
52
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

robotkernel - pypi Package Compare versions

Comparing version
1.6rc1
 to
1.6rc2
+15
-4
_templates/lite-demo.html

@@ -9,2 +9,7 @@ <aside class="navbar-demo-box" title="try RobotKernel in your browser right now.">

title="give a room name to enable shared editing with videochat"
/><br/>as <input
id="user-name"
type="text"
placeholder="nobody"
title="give your username for shared editing with videochat"
/> in...</em>

@@ -25,2 +30,3 @@ </div>

<input name="room" type="hidden" value="" />
<input name="username" type="hidden" value="" />
<input name="JVC-PUBLIC" type="hidden" value="" />

@@ -36,6 +42,13 @@ </form>

const roomName = $("#room-name");
const userName = $("#user-name");
roomName.on("input", () => {
$("input[name='room']").prop("value", roomName.prop("value"));
$("input[name='username']").prop("value", userName.prop("value"));
$("input[name='JVC-PUBLIC']").prop("value", roomName.prop("value"));
});
userName.on("input", () => {
$("input[name='room']").prop("value", roomName.prop("value"));
$("input[name='username']").prop("value", userName.prop("value"));
$("input[name='JVC-PUBLIC']").prop("value", roomName.prop("value"));
});
});

@@ -101,4 +114,2 @@ </script>

}
.navbar-demo-box > .demo-label {

@@ -109,3 +120,3 @@ flex: 1;

}
#room-name {
#room-name, #user-name {
margin-left: 0.5em;

@@ -121,3 +132,3 @@ display: inline-box;

}
#room-name::placeholder{
#room-name::placeholder, #user-name::placeholder {
font-style: italic;

@@ -124,0 +135,0 @@ color: var(--pg-layout-color0);

+9
-0
CHANGELOG.rst
Changelog
=========
1.6rc2 (2022-09-22)
-------------------
- Fix issue where multiple keyword buttons did not work as expected on ipywidgets >= 8
[datakurre]
- Update Selenium helpers to current Selenium API
[RomaCZ]
1.6rc1 (2022-04-07)

@@ -5,0 +14,0 @@ -------------------

+3
-2
docs/environment.yml

@@ -7,3 +7,3 @@ channels:

# docs
- jupyter-book
- jupyter-book==0.12.3
- black

@@ -18,2 +18,3 @@ - sphinx-autoapi

- jupyter-videochat
- jupyterlab-webrtc-docprovider
- wxyz_lab

@@ -30,3 +31,3 @@ # dev stuff

# lite deps
- jupyterlite[all] ==0.1.0b4
- jupyterlite[all] ==0.1.0b7
- ../lite/jupyterlite-robotkernel
+1
-1
docs/index.rst

@@ -23,3 +23,3 @@ RobotKernel

* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/starter/robotkernel-quickstart
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/example.ipynb

@@ -26,0 +26,0 @@ * Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb

+2
-2
MANIFEST.in

@@ -5,5 +5,6 @@ graft src/robotkernel

graft atest
graft _templates
recursive-include src *.js
include LICENSE *.rstj
include LICENSE *.rst *.yml
exclude Makefile Dockerfile requirements*.txt *.nix *.png *.ipynb *.json dodo.py conf.py

@@ -17,4 +18,3 @@

prune pkgs
prune src/jupyterlab_robotmode
global-exclude *.py[co]
+552
-546
PKG-INFO

@@ -1,4 +0,4 @@

Metadata-Version: 2.1
Metadata-Version: 1.1
Name: robotkernel
Version: 1.6rc1
Version: 1.6rc2
Summary: A Jupyter kernel for interactive acceptance-test-driven development with the Robot Framework

@@ -9,2 +9,552 @@ Home-page: https://github.com/robots-from-jupyter/robotkernel

License: BSD-3-Clause
Description: Robotkernel
===========
|Smoketest Badge|
RobotKernel is a `Robot Framework`_ IPython_ kernel for `Jupyter Notebook`_ and JupyterLab_. It powers RobotLab_ – the Robot Framework JupyterLab distribution. Check a `video to see it in action`_ and `read the documentation`_.
RobotKernel requires Python 3.6 or later with setuptools 40.5.0 later and Robot Framework Robot Framework 3.1 or later.
.. |Smoketest Badge| image:: https://github.com/robots-from-jupyter/robotkernel/workflows/smoketest/badge.svg
.. _video to see it in action: https://youtu.be/uYGh9_c3b7s
.. _read the documentation: https://robots-from-jupyter.github.io/robotkernel/
.. _Robot Framework: http://robotframework.org/
.. _IPython: https://ipython.org/
.. _Jupyter Notebook: https://jupyter.readthedocs.io/en/latest/
.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/
.. _RobotLab: https://github.com/robots-from-jupyter/robotlab/releases
For alternative Robot Framework IPython kernel, check out `ipythonrobotframework`_ or `xeus-robot`_.
.. _ipythonrobotframework: https://github.com/gtri/irobotframework
.. _xeus-robot: https://github.com/jupyter-xeus/xeus-robot
Try RobotKernel
---------------
You can try RobotKernel instantly without installing it at MyBinder_ cloud:
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/example.ipynb
* Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb
Note: Log | Report -links on saved notebooks may not be clickable `until notebook is "trusted"`__ ("Trust Notebook" in JupyterLab Commands) the related cells have been executed again.
.. _MyBinder: https://mybinder.org/
__ https://jupyter-notebook.readthedocs.io/en/latest/security.html#updating-trust
Install RobotKernel
-------------------
RobotKernel can be installed using the usual Python package manager tools, like pip:
.. code:: bash
$ pip install robotkernel
For JupyterLab it is recommended to also install the Robot Framework syntax highlighting and Jupyter widgets support:
.. code:: bash
$ jupyter labextension install jupyterlab_robotmode
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
For some environments it might be required to run the following command to manually register robotkernel as an available Jupyter kernel:
.. code:: bash
$ python -m robotkernel.install
Export to .robot
----------------
It is possible to export Robot Framework Jupyter notebooks to regular plain text ``.robot`` files for usage without Jupyter:
.. code:: bash
$ jupyter nbconvert --to script example.ipynb
.. _nbconvert: https://nbconvert.readthedocs.io/
Execute notebooks
-----------------
RobotKernel installs a script named ``nbrobot``. It can be used instead of Robot Framework's ``robot`` test runner to execute Robot Framework with ``.ipynb``-extension support:
.. code:: bash
$ nbrobot example.ipynb
Hacking RobotKernel
-------------------
Create and activate a new Python virtual environment:
.. code:: bash
$ venv myenv
$ source myenv/bin/activate
Install Jupyter:
.. code:: bash
$ pip install --upgrade pip setuptools
$ pip install jupyter
Clone this kernel:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
Install the kernel into the virtualenv in develop mode:
.. code:: bash
$ python setup.py develop
$ python -m robotkernel.install
Launch the jupyter:
.. code:: bash
$ jupyter notebook
Reloading the kernel reloads the code.
`Learn more about Jupyter kernel development.`__
__ http://jupyter.readthedocs.io/en/latest/install.html
Nix-shell
---------
This repository includes an opinionated environment for running and developing RobotKernel with Nix_ with `Cachix-powered binary cache`__.
__ https://robots-from-jupyter.cachix.org/
Launch Jupyter Notebook with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")' --run "jupyter notebook"
.. _Nix: https://nixos.org/nix/
Launch JupyterLab with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")'
$ jupyter labextension install jupyterlab_robotmode --app-dir=.jupyterlab
$ jupyter lab --app-dir=.jupyterlab
$ exit
Add ``--arg vim true`` to enable `vim bindings`_.
.. _vim bindings: https://github.com/lambdalisue/jupyter-vim-binding
Open development environment with Nix:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
$ nix-build setup.nix -A env # to generate ./result/bin/python for IDE
$ nix-shell setup.nix -A develop
Changelog
=========
1.6rc2 (2022-09-22)
-------------------
- Fix issue where multiple keyword buttons did not work as expected on ipywidgets >= 8
[datakurre]
- Update Selenium helpers to current Selenium API
[RomaCZ]
1.6rc1 (2022-04-07)
-------------------
- Fix support for ipywidgets >= 8.0.0rc0
[datakurre]
- Update classic Notebook mode with Robot Framework 5 features
[bollwyvl, datakurre]
- Add pyolite support
[datakurre]
- Add %sticky magic LibraryName -magic to optionally preserve state of global and suite scope libraries between executions
[datakurre]
1.5.1 (2021-09-28)
------------------
- Fix set_parent signature
[martinRenou]
1.5.0 (2021-04-22)
------------------
- Add support for robotframework 4.0
[datakurre]
1.4.0 (2020-04-27)
------------------
- Add support for robotframework 3.2
[datakurre]
- Change kernel mimetype to "text/x-robotframework"
[datakurre]
1.3.0 (2020-01-09)
------------------
- Add jupyterlab-starters' based quick start and tutorial
[datakurre]
- Fix issue where Selenium test or task execution resulted in breaking
exception, because temporary execution directory could not be cleared due to
open geckodriver.log
[datakurre]
1.2.2 (2020-01-05)
------------------
- Fix regression where wrong nbimporter was not automatically imported
[datakurre]
1.2.1 (2019-12-30)
------------------
- Fix issue where data uri images were not displayed on notebook
[datakurre]
- Fix issue where list type suite variables were not correctly restored
[datakurre]
1.2 (2019-12-06)
----------------
- Add support for Robot Framework 3.2a1
[datakurre]
- Add support for displaying multiline text return values
[datakurre]
- Add support for sticky JupyterLibrary webdriver connections
[datakurre]
- Fix issue where updated global variables were overridden from saved
variables from the previous execution
[datakurre]
1.1.1 (2019-12-05)
------------------
- Fix issue where library autocompletion override settings keywords
autocompletion
[datakurre]
1.1.0 (2019-12-05)
------------------
- Add Library autocompletion after Library keyword within Settings
[datakurre]
1.0.2 (2019-12-04)
------------------
- Fix issue where text strings feed to JSON displayed a warning
[datakurre]
- Fix JupyterLab context help support to work when clicked in the middlle of a keyword
[datakurre]
- Fix to close dangling Selenium connections
[datakurre]
1.0.1 (2019-09-19)
------------------
- Fix issue where ${CURDIR} was broken on Windows, because it contained path without
escaped path separators required by Robot Framework
[datakurre]
- Fix issue where suite variable listener reported errors when running robot suites,
because it tried to restore dictionary variables with empty value
[datakurre]
1.0 (2019-09-12)
----------------
- Fix issue where log and report links did not open on JupyterLab 1.0
[datakurre]
1.0rc1 (2019-04-01)
-------------------
- Move tutorials notebooks into notebooks folder
[datakurre]
- Fix WhiteLibrary autocompletion to suggest selectors with :-separator
instead of =-separator
[datakurre]
0.12.2 (2019-03-30)
-------------------
- Fix remaining where keeping state of suite level variables between cell
executions since 0.12.0 caused regression by fixing the listener to ignore
all known built-in variables
[datakurre]
0.12.1 (2019-03-27)
-------------------
- Fix issue where keeping state of suite level variables between cell
executions resulted in errors caused by outdated output directory
from the old variables
[datakurre]
0.12.0 (2019-03-26)
-------------------
New features:
- Add keyword execution widgets below executed keyword cells; Add to toggle
widgets on consecutive executions without code changes
[datakurre]
- Add listener to keep state of suite level variables between robot executions
[datakurre]
- Add IPython display hooks
[datakurre]
New features:
- Add updates to highlighting from ipythonrobotframework
[datakurre]
0.11.0 (2019-01-29)
-------------------
- Add WhiteLibrary state support and interactive element picker
[datakurre]
- Add WhiteLibraryCompanion keyword library to interactively
select elements and click elements with OpenCV templates
[datakurre]
0.10.2 (2019-01-11)
-------------------
- Fix syntax highlighting issue where only the first variable of many was
highlighted
[datakurre]
0.10.1 (2019-01-10)
-------------------
- Update package trove classifiers
[datakurre]
0.10.0 (2019-01-08)
-------------------
Breaking:
- Setuptools 40.5.0 later and Robot Framework 3.1 or later.
[datakurre]
new features:
- Add pregenerated kernel.json in data_files to auto-install robotkernel,
but requiring
[datakurre]
0.9.0 (2019-01-04)
------------------
New features:
- Rewrite status updater to the status of currently run test as
``trobber | test name | keyword name | robot.api.logger.console message``
[datakurre]
- Add embedded log and report to include Download-links at top right corner
[datakurre]
- Add to display the results of the last executed keyword as the notebook
result for the executed code cell
[datakurre]
- Add syntax highlighting for variables and assignment operators
[datakurre]
Bug fixes:
- Fix issue where setup.cfg contained OS specific path separators preventing
build on Windows
[datakurre]
- Fix issue where PNGs were interpreted as APNG on Windows preventing
them from being rendered on Windows
[datakurre]
- Update example notebook to use SeleniumLibrary and SeleniumScreenshots
instead of SeleniumLibrary and Selenium2Screenshots
[datakurre]
- Add to always reload libraries imported from other notebooks
[datakurre]
0.8.0 (2018-12-14)
------------------
- Add to auto-import nbimporter when available to make it possible to
import eg. keyword libraries from Python notebooks
[datakurre]
- Fix issue where nbrobot did support %%python module magic
[datakurre]
0.7.1 (2018-11-20)
------------------
- Add to require robotframework >= 3.1b1 in requires
0.7.0 (2018-10-31)
------------------
Breaking:
- Requires robotframework >= 3.1b1
Other:
- Add to create nbreader and nblibdoc cli to run robot with notebook reader
support
[datakurre]
- Add Selenium completions to sometimes include raw Simmer results with
simplfied id completion results
[datakurre]
- Add proof-of-concept selector completion for Appium and AutoIT libraries
[datakurre]
- Fix screenshot processor to also discover images with absolute path or within
the current working directory
[datakurre]
0.6.3 (2018-10-19)
------------------
This is the last release compatible with robotframework < 3.1
- Remove deprecated replace-flag from kernel installer
[datakurre]
0.6.2 (2018-10-19)
------------------
- Fix compatibility issue with robotframework < 3.1
[datakurre]
0.6.1 (2018-10-19)
------------------
- Fix issue where kernel installation produced broken kernel.json on Windows
[datakurre]
0.6.0 (2018-10-18)
------------------
- Revert data source path from temporary directory into current working
directory to allow local libraries and resources work in the usual use cases
[datakurre]
- Add experimental Simmerjs based CSS-selector builder and element picker with
when auto-completion is called with empty "css:"-selector
[datakurre]
- Add experimental Selenium selector auto-completion
[datakurre]
- Add dummy variable completion with only variables from current suite without
context knowledge
[datakurre]
- Add inline documentation links to Robot Framework User Guide for structural
keywords
[datakurre]
0.5.4 (2018-10-09)
------------------
- Fix issue where single term keywords got no completions
[datakurre]
0.5.3 (2018-10-09)
------------------
- Update README
[datakurre]
0.5.1 (2018-10-08)
------------------
- Auto completion and keyword doc inspection enhancements
[datakurre]
0.5.0 (2018-10-08)
------------------
- Add auto-completion, keyword doc inspection and support for
replacing and deleting cell history on Jupyter lab
[datakurre]
0.4.0 (2018-09-26)
------------------
- Add support for robotframework 3.1a2
[datakurre]
- Add support for reporting RPA suites with "Tasks" instead of "Tests"
[datakurre]
0.3.5 (2018-09-25)
------------------
- Update README with notebook execution instructions
[datakurre]
0.3.4 (2018-09-25)
------------------
- Update README
[datakurre]
0.3.3 (2018-09-25)
------------------
- Note on README that Log | Report -links require trusting the notebook
[datakurre]
- Fix to wrap test execution updates with '<pre>' for better readability
[datakurre]
0.3.2 (2018-09-25)
------------------
- Change to always send display data updates in text/html to workaround a bug
that caused 'undefined' to be rendered in JupyterLab
[datakurre]
0.3.1 (2018-09-24)
------------------
- Update README
[datakurre]
0.3.0 (2018-09-23)
------------------
- First release.
[datakurre]
Keywords: Interactive,Interpreter,Shell,Testing,Web

@@ -24,545 +574,1 @@ Platform: UNKNOWN

Classifier: Topic :: Software Development :: Testing
License-File: LICENSE
Robotkernel
===========
|Smoketest Badge|
RobotKernel is a `Robot Framework`_ IPython_ kernel for `Jupyter Notebook`_ and JupyterLab_. It powers RobotLab_ – the Robot Framework JupyterLab distribution. Check a `video to see it in action`_ and `read the documentation`_.
RobotKernel requires Python 3.6 or later with setuptools 40.5.0 later and Robot Framework Robot Framework 3.1 or later.
.. |Smoketest Badge| image:: https://github.com/robots-from-jupyter/robotkernel/workflows/smoketest/badge.svg
.. _video to see it in action: https://youtu.be/uYGh9_c3b7s
.. _read the documentation: https://robots-from-jupyter.github.io/robotkernel/
.. _Robot Framework: http://robotframework.org/
.. _IPython: https://ipython.org/
.. _Jupyter Notebook: https://jupyter.readthedocs.io/en/latest/
.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/
.. _RobotLab: https://github.com/robots-from-jupyter/robotlab/releases
For alternative Robot Framework IPython kernel, check out `ipythonrobotframework`_ or `xeus-robot`_.
.. _ipythonrobotframework: https://github.com/gtri/irobotframework
.. _xeus-robot: https://github.com/jupyter-xeus/xeus-robot
Try RobotKernel
---------------
You can try RobotKernel instantly without installing it at MyBinder_ cloud:
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/starter/robotkernel-quickstart
* Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb
Note: Log | Report -links on saved notebooks may not be clickable `until notebook is "trusted"`__ ("Trust Notebook" in JupyterLab Commands) the related cells have been executed again.
.. _MyBinder: https://mybinder.org/
__ https://jupyter-notebook.readthedocs.io/en/latest/security.html#updating-trust
Install RobotKernel
-------------------
RobotKernel can be installed using the usual Python package manager tools, like pip:
.. code:: bash
$ pip install robotkernel
For JupyterLab it is recommended to also install the Robot Framework syntax highlighting and Jupyter widgets support:
.. code:: bash
$ jupyter labextension install jupyterlab_robotmode
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
For some environments it might be required to run the following command to manually register robotkernel as an available Jupyter kernel:
.. code:: bash
$ python -m robotkernel.install
Export to .robot
----------------
It is possible to export Robot Framework Jupyter notebooks to regular plain text ``.robot`` files for usage without Jupyter:
.. code:: bash
$ jupyter nbconvert --to script example.ipynb
.. _nbconvert: https://nbconvert.readthedocs.io/
Execute notebooks
-----------------
RobotKernel installs a script named ``nbrobot``. It can be used instead of Robot Framework's ``robot`` test runner to execute Robot Framework with ``.ipynb``-extension support:
.. code:: bash
$ nbrobot example.ipynb
Hacking RobotKernel
-------------------
Create and activate a new Python virtual environment:
.. code:: bash
$ venv myenv
$ source myenv/bin/activate
Install Jupyter:
.. code:: bash
$ pip install --upgrade pip setuptools
$ pip install jupyter
Clone this kernel:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
Install the kernel into the virtualenv in develop mode:
.. code:: bash
$ python setup.py develop
$ python -m robotkernel.install
Launch the jupyter:
.. code:: bash
$ jupyter notebook
Reloading the kernel reloads the code.
`Learn more about Jupyter kernel development.`__
__ http://jupyter.readthedocs.io/en/latest/install.html
Nix-shell
---------
This repository includes an opinionated environment for running and developing RobotKernel with Nix_ with `Cachix-powered binary cache`__.
__ https://robots-from-jupyter.cachix.org/
Launch Jupyter Notebook with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")' --run "jupyter notebook"
.. _Nix: https://nixos.org/nix/
Launch JupyterLab with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")'
$ jupyter labextension install jupyterlab_robotmode --app-dir=.jupyterlab
$ jupyter lab --app-dir=.jupyterlab
$ exit
Add ``--arg vim true`` to enable `vim bindings`_.
.. _vim bindings: https://github.com/lambdalisue/jupyter-vim-binding
Open development environment with Nix:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
$ nix-build setup.nix -A env # to generate ./result/bin/python for IDE
$ nix-shell setup.nix -A develop
Changelog
=========
1.6rc1 (2022-04-07)
-------------------
- Fix support for ipywidgets >= 8.0.0rc0
[datakurre]
- Update classic Notebook mode with Robot Framework 5 features
[bollwyvl, datakurre]
- Add pyolite support
[datakurre]
- Add %sticky magic LibraryName -magic to optionally preserve state of global and suite scope libraries between executions
[datakurre]
1.5.1 (2021-09-28)
------------------
- Fix set_parent signature
[martinRenou]
1.5.0 (2021-04-22)
------------------
- Add support for robotframework 4.0
[datakurre]
1.4.0 (2020-04-27)
------------------
- Add support for robotframework 3.2
[datakurre]
- Change kernel mimetype to "text/x-robotframework"
[datakurre]
1.3.0 (2020-01-09)
------------------
- Add jupyterlab-starters' based quick start and tutorial
[datakurre]
- Fix issue where Selenium test or task execution resulted in breaking
exception, because temporary execution directory could not be cleared due to
open geckodriver.log
[datakurre]
1.2.2 (2020-01-05)
------------------
- Fix regression where wrong nbimporter was not automatically imported
[datakurre]
1.2.1 (2019-12-30)
------------------
- Fix issue where data uri images were not displayed on notebook
[datakurre]
- Fix issue where list type suite variables were not correctly restored
[datakurre]
1.2 (2019-12-06)
----------------
- Add support for Robot Framework 3.2a1
[datakurre]
- Add support for displaying multiline text return values
[datakurre]
- Add support for sticky JupyterLibrary webdriver connections
[datakurre]
- Fix issue where updated global variables were overridden from saved
variables from the previous execution
[datakurre]
1.1.1 (2019-12-05)
------------------
- Fix issue where library autocompletion override settings keywords
autocompletion
[datakurre]
1.1.0 (2019-12-05)
------------------
- Add Library autocompletion after Library keyword within Settings
[datakurre]
1.0.2 (2019-12-04)
------------------
- Fix issue where text strings feed to JSON displayed a warning
[datakurre]
- Fix JupyterLab context help support to work when clicked in the middlle of a keyword
[datakurre]
- Fix to close dangling Selenium connections
[datakurre]
1.0.1 (2019-09-19)
------------------
- Fix issue where ${CURDIR} was broken on Windows, because it contained path without
escaped path separators required by Robot Framework
[datakurre]
- Fix issue where suite variable listener reported errors when running robot suites,
because it tried to restore dictionary variables with empty value
[datakurre]
1.0 (2019-09-12)
----------------
- Fix issue where log and report links did not open on JupyterLab 1.0
[datakurre]
1.0rc1 (2019-04-01)
-------------------
- Move tutorials notebooks into notebooks folder
[datakurre]
- Fix WhiteLibrary autocompletion to suggest selectors with :-separator
instead of =-separator
[datakurre]
0.12.2 (2019-03-30)
-------------------
- Fix remaining where keeping state of suite level variables between cell
executions since 0.12.0 caused regression by fixing the listener to ignore
all known built-in variables
[datakurre]
0.12.1 (2019-03-27)
-------------------
- Fix issue where keeping state of suite level variables between cell
executions resulted in errors caused by outdated output directory
from the old variables
[datakurre]
0.12.0 (2019-03-26)
-------------------
New features:
- Add keyword execution widgets below executed keyword cells; Add to toggle
widgets on consecutive executions without code changes
[datakurre]
- Add listener to keep state of suite level variables between robot executions
[datakurre]
- Add IPython display hooks
[datakurre]
New features:
- Add updates to highlighting from ipythonrobotframework
[datakurre]
0.11.0 (2019-01-29)
-------------------
- Add WhiteLibrary state support and interactive element picker
[datakurre]
- Add WhiteLibraryCompanion keyword library to interactively
select elements and click elements with OpenCV templates
[datakurre]
0.10.2 (2019-01-11)
-------------------
- Fix syntax highlighting issue where only the first variable of many was
highlighted
[datakurre]
0.10.1 (2019-01-10)
-------------------
- Update package trove classifiers
[datakurre]
0.10.0 (2019-01-08)
-------------------
Breaking:
- Setuptools 40.5.0 later and Robot Framework 3.1 or later.
[datakurre]
new features:
- Add pregenerated kernel.json in data_files to auto-install robotkernel,
but requiring
[datakurre]
0.9.0 (2019-01-04)
------------------
New features:
- Rewrite status updater to the status of currently run test as
``trobber | test name | keyword name | robot.api.logger.console message``
[datakurre]
- Add embedded log and report to include Download-links at top right corner
[datakurre]
- Add to display the results of the last executed keyword as the notebook
result for the executed code cell
[datakurre]
- Add syntax highlighting for variables and assignment operators
[datakurre]
Bug fixes:
- Fix issue where setup.cfg contained OS specific path separators preventing
build on Windows
[datakurre]
- Fix issue where PNGs were interpreted as APNG on Windows preventing
them from being rendered on Windows
[datakurre]
- Update example notebook to use SeleniumLibrary and SeleniumScreenshots
instead of SeleniumLibrary and Selenium2Screenshots
[datakurre]
- Add to always reload libraries imported from other notebooks
[datakurre]
0.8.0 (2018-12-14)
------------------
- Add to auto-import nbimporter when available to make it possible to
import eg. keyword libraries from Python notebooks
[datakurre]
- Fix issue where nbrobot did support %%python module magic
[datakurre]
0.7.1 (2018-11-20)
------------------
- Add to require robotframework >= 3.1b1 in requires
0.7.0 (2018-10-31)
------------------
Breaking:
- Requires robotframework >= 3.1b1
Other:
- Add to create nbreader and nblibdoc cli to run robot with notebook reader
support
[datakurre]
- Add Selenium completions to sometimes include raw Simmer results with
simplfied id completion results
[datakurre]
- Add proof-of-concept selector completion for Appium and AutoIT libraries
[datakurre]
- Fix screenshot processor to also discover images with absolute path or within
the current working directory
[datakurre]
0.6.3 (2018-10-19)
------------------
This is the last release compatible with robotframework < 3.1
- Remove deprecated replace-flag from kernel installer
[datakurre]
0.6.2 (2018-10-19)
------------------
- Fix compatibility issue with robotframework < 3.1
[datakurre]
0.6.1 (2018-10-19)
------------------
- Fix issue where kernel installation produced broken kernel.json on Windows
[datakurre]
0.6.0 (2018-10-18)
------------------
- Revert data source path from temporary directory into current working
directory to allow local libraries and resources work in the usual use cases
[datakurre]
- Add experimental Simmerjs based CSS-selector builder and element picker with
when auto-completion is called with empty "css:"-selector
[datakurre]
- Add experimental Selenium selector auto-completion
[datakurre]
- Add dummy variable completion with only variables from current suite without
context knowledge
[datakurre]
- Add inline documentation links to Robot Framework User Guide for structural
keywords
[datakurre]
0.5.4 (2018-10-09)
------------------
- Fix issue where single term keywords got no completions
[datakurre]
0.5.3 (2018-10-09)
------------------
- Update README
[datakurre]
0.5.1 (2018-10-08)
------------------
- Auto completion and keyword doc inspection enhancements
[datakurre]
0.5.0 (2018-10-08)
------------------
- Add auto-completion, keyword doc inspection and support for
replacing and deleting cell history on Jupyter lab
[datakurre]
0.4.0 (2018-09-26)
------------------
- Add support for robotframework 3.1a2
[datakurre]
- Add support for reporting RPA suites with "Tasks" instead of "Tests"
[datakurre]
0.3.5 (2018-09-25)
------------------
- Update README with notebook execution instructions
[datakurre]
0.3.4 (2018-09-25)
------------------
- Update README
[datakurre]
0.3.3 (2018-09-25)
------------------
- Note on README that Log | Report -links require trusting the notebook
[datakurre]
- Fix to wrap test execution updates with '<pre>' for better readability
[datakurre]
0.3.2 (2018-09-25)
------------------
- Change to always send display data updates in text/html to workaround a bug
that caused 'undefined' to be rendered in JupyterLab
[datakurre]
0.3.1 (2018-09-24)
------------------
- Update README
[datakurre]
0.3.0 (2018-09-23)
------------------
- First release.
[datakurre]
+1
-1
README.rst

@@ -30,3 +30,3 @@ Robotkernel

* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/starter/robotkernel-quickstart
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/example.ipynb

@@ -33,0 +33,0 @@ * Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb

+1
-1
setup.cfg
[metadata]
name = robotkernel
version = 1.6rc1
version = 1.6rc2
description = A Jupyter kernel for interactive acceptance-test-driven development with the Robot Framework

@@ -5,0 +5,0 @@ long_description = file: README.rst, CHANGELOG.rst

+552
-546
src/robotkernel.egg-info/PKG-INFO

@@ -1,4 +0,4 @@

Metadata-Version: 2.1
Metadata-Version: 1.1
Name: robotkernel
Version: 1.6rc1
Version: 1.6rc2
Summary: A Jupyter kernel for interactive acceptance-test-driven development with the Robot Framework

@@ -9,2 +9,552 @@ Home-page: https://github.com/robots-from-jupyter/robotkernel

License: BSD-3-Clause
Description: Robotkernel
===========
|Smoketest Badge|
RobotKernel is a `Robot Framework`_ IPython_ kernel for `Jupyter Notebook`_ and JupyterLab_. It powers RobotLab_ – the Robot Framework JupyterLab distribution. Check a `video to see it in action`_ and `read the documentation`_.
RobotKernel requires Python 3.6 or later with setuptools 40.5.0 later and Robot Framework Robot Framework 3.1 or later.
.. |Smoketest Badge| image:: https://github.com/robots-from-jupyter/robotkernel/workflows/smoketest/badge.svg
.. _video to see it in action: https://youtu.be/uYGh9_c3b7s
.. _read the documentation: https://robots-from-jupyter.github.io/robotkernel/
.. _Robot Framework: http://robotframework.org/
.. _IPython: https://ipython.org/
.. _Jupyter Notebook: https://jupyter.readthedocs.io/en/latest/
.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/
.. _RobotLab: https://github.com/robots-from-jupyter/robotlab/releases
For alternative Robot Framework IPython kernel, check out `ipythonrobotframework`_ or `xeus-robot`_.
.. _ipythonrobotframework: https://github.com/gtri/irobotframework
.. _xeus-robot: https://github.com/jupyter-xeus/xeus-robot
Try RobotKernel
---------------
You can try RobotKernel instantly without installing it at MyBinder_ cloud:
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/example.ipynb
* Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb
Note: Log | Report -links on saved notebooks may not be clickable `until notebook is "trusted"`__ ("Trust Notebook" in JupyterLab Commands) the related cells have been executed again.
.. _MyBinder: https://mybinder.org/
__ https://jupyter-notebook.readthedocs.io/en/latest/security.html#updating-trust
Install RobotKernel
-------------------
RobotKernel can be installed using the usual Python package manager tools, like pip:
.. code:: bash
$ pip install robotkernel
For JupyterLab it is recommended to also install the Robot Framework syntax highlighting and Jupyter widgets support:
.. code:: bash
$ jupyter labextension install jupyterlab_robotmode
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
For some environments it might be required to run the following command to manually register robotkernel as an available Jupyter kernel:
.. code:: bash
$ python -m robotkernel.install
Export to .robot
----------------
It is possible to export Robot Framework Jupyter notebooks to regular plain text ``.robot`` files for usage without Jupyter:
.. code:: bash
$ jupyter nbconvert --to script example.ipynb
.. _nbconvert: https://nbconvert.readthedocs.io/
Execute notebooks
-----------------
RobotKernel installs a script named ``nbrobot``. It can be used instead of Robot Framework's ``robot`` test runner to execute Robot Framework with ``.ipynb``-extension support:
.. code:: bash
$ nbrobot example.ipynb
Hacking RobotKernel
-------------------
Create and activate a new Python virtual environment:
.. code:: bash
$ venv myenv
$ source myenv/bin/activate
Install Jupyter:
.. code:: bash
$ pip install --upgrade pip setuptools
$ pip install jupyter
Clone this kernel:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
Install the kernel into the virtualenv in develop mode:
.. code:: bash
$ python setup.py develop
$ python -m robotkernel.install
Launch the jupyter:
.. code:: bash
$ jupyter notebook
Reloading the kernel reloads the code.
`Learn more about Jupyter kernel development.`__
__ http://jupyter.readthedocs.io/en/latest/install.html
Nix-shell
---------
This repository includes an opinionated environment for running and developing RobotKernel with Nix_ with `Cachix-powered binary cache`__.
__ https://robots-from-jupyter.cachix.org/
Launch Jupyter Notebook with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")' --run "jupyter notebook"
.. _Nix: https://nixos.org/nix/
Launch JupyterLab with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")'
$ jupyter labextension install jupyterlab_robotmode --app-dir=.jupyterlab
$ jupyter lab --app-dir=.jupyterlab
$ exit
Add ``--arg vim true`` to enable `vim bindings`_.
.. _vim bindings: https://github.com/lambdalisue/jupyter-vim-binding
Open development environment with Nix:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
$ nix-build setup.nix -A env # to generate ./result/bin/python for IDE
$ nix-shell setup.nix -A develop
Changelog
=========
1.6rc2 (2022-09-22)
-------------------
- Fix issue where multiple keyword buttons did not work as expected on ipywidgets >= 8
[datakurre]
- Update Selenium helpers to current Selenium API
[RomaCZ]
1.6rc1 (2022-04-07)
-------------------
- Fix support for ipywidgets >= 8.0.0rc0
[datakurre]
- Update classic Notebook mode with Robot Framework 5 features
[bollwyvl, datakurre]
- Add pyolite support
[datakurre]
- Add %sticky magic LibraryName -magic to optionally preserve state of global and suite scope libraries between executions
[datakurre]
1.5.1 (2021-09-28)
------------------
- Fix set_parent signature
[martinRenou]
1.5.0 (2021-04-22)
------------------
- Add support for robotframework 4.0
[datakurre]
1.4.0 (2020-04-27)
------------------
- Add support for robotframework 3.2
[datakurre]
- Change kernel mimetype to "text/x-robotframework"
[datakurre]
1.3.0 (2020-01-09)
------------------
- Add jupyterlab-starters' based quick start and tutorial
[datakurre]
- Fix issue where Selenium test or task execution resulted in breaking
exception, because temporary execution directory could not be cleared due to
open geckodriver.log
[datakurre]
1.2.2 (2020-01-05)
------------------
- Fix regression where wrong nbimporter was not automatically imported
[datakurre]
1.2.1 (2019-12-30)
------------------
- Fix issue where data uri images were not displayed on notebook
[datakurre]
- Fix issue where list type suite variables were not correctly restored
[datakurre]
1.2 (2019-12-06)
----------------
- Add support for Robot Framework 3.2a1
[datakurre]
- Add support for displaying multiline text return values
[datakurre]
- Add support for sticky JupyterLibrary webdriver connections
[datakurre]
- Fix issue where updated global variables were overridden from saved
variables from the previous execution
[datakurre]
1.1.1 (2019-12-05)
------------------
- Fix issue where library autocompletion override settings keywords
autocompletion
[datakurre]
1.1.0 (2019-12-05)
------------------
- Add Library autocompletion after Library keyword within Settings
[datakurre]
1.0.2 (2019-12-04)
------------------
- Fix issue where text strings feed to JSON displayed a warning
[datakurre]
- Fix JupyterLab context help support to work when clicked in the middlle of a keyword
[datakurre]
- Fix to close dangling Selenium connections
[datakurre]
1.0.1 (2019-09-19)
------------------
- Fix issue where ${CURDIR} was broken on Windows, because it contained path without
escaped path separators required by Robot Framework
[datakurre]
- Fix issue where suite variable listener reported errors when running robot suites,
because it tried to restore dictionary variables with empty value
[datakurre]
1.0 (2019-09-12)
----------------
- Fix issue where log and report links did not open on JupyterLab 1.0
[datakurre]
1.0rc1 (2019-04-01)
-------------------
- Move tutorials notebooks into notebooks folder
[datakurre]
- Fix WhiteLibrary autocompletion to suggest selectors with :-separator
instead of =-separator
[datakurre]
0.12.2 (2019-03-30)
-------------------
- Fix remaining where keeping state of suite level variables between cell
executions since 0.12.0 caused regression by fixing the listener to ignore
all known built-in variables
[datakurre]
0.12.1 (2019-03-27)
-------------------
- Fix issue where keeping state of suite level variables between cell
executions resulted in errors caused by outdated output directory
from the old variables
[datakurre]
0.12.0 (2019-03-26)
-------------------
New features:
- Add keyword execution widgets below executed keyword cells; Add to toggle
widgets on consecutive executions without code changes
[datakurre]
- Add listener to keep state of suite level variables between robot executions
[datakurre]
- Add IPython display hooks
[datakurre]
New features:
- Add updates to highlighting from ipythonrobotframework
[datakurre]
0.11.0 (2019-01-29)
-------------------
- Add WhiteLibrary state support and interactive element picker
[datakurre]
- Add WhiteLibraryCompanion keyword library to interactively
select elements and click elements with OpenCV templates
[datakurre]
0.10.2 (2019-01-11)
-------------------
- Fix syntax highlighting issue where only the first variable of many was
highlighted
[datakurre]
0.10.1 (2019-01-10)
-------------------
- Update package trove classifiers
[datakurre]
0.10.0 (2019-01-08)
-------------------
Breaking:
- Setuptools 40.5.0 later and Robot Framework 3.1 or later.
[datakurre]
new features:
- Add pregenerated kernel.json in data_files to auto-install robotkernel,
but requiring
[datakurre]
0.9.0 (2019-01-04)
------------------
New features:
- Rewrite status updater to the status of currently run test as
``trobber | test name | keyword name | robot.api.logger.console message``
[datakurre]
- Add embedded log and report to include Download-links at top right corner
[datakurre]
- Add to display the results of the last executed keyword as the notebook
result for the executed code cell
[datakurre]
- Add syntax highlighting for variables and assignment operators
[datakurre]
Bug fixes:
- Fix issue where setup.cfg contained OS specific path separators preventing
build on Windows
[datakurre]
- Fix issue where PNGs were interpreted as APNG on Windows preventing
them from being rendered on Windows
[datakurre]
- Update example notebook to use SeleniumLibrary and SeleniumScreenshots
instead of SeleniumLibrary and Selenium2Screenshots
[datakurre]
- Add to always reload libraries imported from other notebooks
[datakurre]
0.8.0 (2018-12-14)
------------------
- Add to auto-import nbimporter when available to make it possible to
import eg. keyword libraries from Python notebooks
[datakurre]
- Fix issue where nbrobot did support %%python module magic
[datakurre]
0.7.1 (2018-11-20)
------------------
- Add to require robotframework >= 3.1b1 in requires
0.7.0 (2018-10-31)
------------------
Breaking:
- Requires robotframework >= 3.1b1
Other:
- Add to create nbreader and nblibdoc cli to run robot with notebook reader
support
[datakurre]
- Add Selenium completions to sometimes include raw Simmer results with
simplfied id completion results
[datakurre]
- Add proof-of-concept selector completion for Appium and AutoIT libraries
[datakurre]
- Fix screenshot processor to also discover images with absolute path or within
the current working directory
[datakurre]
0.6.3 (2018-10-19)
------------------
This is the last release compatible with robotframework < 3.1
- Remove deprecated replace-flag from kernel installer
[datakurre]
0.6.2 (2018-10-19)
------------------
- Fix compatibility issue with robotframework < 3.1
[datakurre]
0.6.1 (2018-10-19)
------------------
- Fix issue where kernel installation produced broken kernel.json on Windows
[datakurre]
0.6.0 (2018-10-18)
------------------
- Revert data source path from temporary directory into current working
directory to allow local libraries and resources work in the usual use cases
[datakurre]
- Add experimental Simmerjs based CSS-selector builder and element picker with
when auto-completion is called with empty "css:"-selector
[datakurre]
- Add experimental Selenium selector auto-completion
[datakurre]
- Add dummy variable completion with only variables from current suite without
context knowledge
[datakurre]
- Add inline documentation links to Robot Framework User Guide for structural
keywords
[datakurre]
0.5.4 (2018-10-09)
------------------
- Fix issue where single term keywords got no completions
[datakurre]
0.5.3 (2018-10-09)
------------------
- Update README
[datakurre]
0.5.1 (2018-10-08)
------------------
- Auto completion and keyword doc inspection enhancements
[datakurre]
0.5.0 (2018-10-08)
------------------
- Add auto-completion, keyword doc inspection and support for
replacing and deleting cell history on Jupyter lab
[datakurre]
0.4.0 (2018-09-26)
------------------
- Add support for robotframework 3.1a2
[datakurre]
- Add support for reporting RPA suites with "Tasks" instead of "Tests"
[datakurre]
0.3.5 (2018-09-25)
------------------
- Update README with notebook execution instructions
[datakurre]
0.3.4 (2018-09-25)
------------------
- Update README
[datakurre]
0.3.3 (2018-09-25)
------------------
- Note on README that Log | Report -links require trusting the notebook
[datakurre]
- Fix to wrap test execution updates with '<pre>' for better readability
[datakurre]
0.3.2 (2018-09-25)
------------------
- Change to always send display data updates in text/html to workaround a bug
that caused 'undefined' to be rendered in JupyterLab
[datakurre]
0.3.1 (2018-09-24)
------------------
- Update README
[datakurre]
0.3.0 (2018-09-23)
------------------
- First release.
[datakurre]
Keywords: Interactive,Interpreter,Shell,Testing,Web

@@ -24,545 +574,1 @@ Platform: UNKNOWN

Classifier: Topic :: Software Development :: Testing
License-File: LICENSE
Robotkernel
===========
|Smoketest Badge|
RobotKernel is a `Robot Framework`_ IPython_ kernel for `Jupyter Notebook`_ and JupyterLab_. It powers RobotLab_ – the Robot Framework JupyterLab distribution. Check a `video to see it in action`_ and `read the documentation`_.
RobotKernel requires Python 3.6 or later with setuptools 40.5.0 later and Robot Framework Robot Framework 3.1 or later.
.. |Smoketest Badge| image:: https://github.com/robots-from-jupyter/robotkernel/workflows/smoketest/badge.svg
.. _video to see it in action: https://youtu.be/uYGh9_c3b7s
.. _read the documentation: https://robots-from-jupyter.github.io/robotkernel/
.. _Robot Framework: http://robotframework.org/
.. _IPython: https://ipython.org/
.. _Jupyter Notebook: https://jupyter.readthedocs.io/en/latest/
.. _JupyterLab: https://jupyterlab.readthedocs.io/en/stable/
.. _RobotLab: https://github.com/robots-from-jupyter/robotlab/releases
For alternative Robot Framework IPython kernel, check out `ipythonrobotframework`_ or `xeus-robot`_.
.. _ipythonrobotframework: https://github.com/gtri/irobotframework
.. _xeus-robot: https://github.com/jupyter-xeus/xeus-robot
Try RobotKernel
---------------
You can try RobotKernel instantly without installing it at MyBinder_ cloud:
* Launch JupyterLab with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=lab/tree/starter/robotkernel-quickstart
* Launch Jupyter Notebook with RobotKernel: https://mybinder.org/v2/gh/robots-from-jupyter/robotkernel/master?urlpath=tree/example.ipynb
Note: Log | Report -links on saved notebooks may not be clickable `until notebook is "trusted"`__ ("Trust Notebook" in JupyterLab Commands) the related cells have been executed again.
.. _MyBinder: https://mybinder.org/
__ https://jupyter-notebook.readthedocs.io/en/latest/security.html#updating-trust
Install RobotKernel
-------------------
RobotKernel can be installed using the usual Python package manager tools, like pip:
.. code:: bash
$ pip install robotkernel
For JupyterLab it is recommended to also install the Robot Framework syntax highlighting and Jupyter widgets support:
.. code:: bash
$ jupyter labextension install jupyterlab_robotmode
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
For some environments it might be required to run the following command to manually register robotkernel as an available Jupyter kernel:
.. code:: bash
$ python -m robotkernel.install
Export to .robot
----------------
It is possible to export Robot Framework Jupyter notebooks to regular plain text ``.robot`` files for usage without Jupyter:
.. code:: bash
$ jupyter nbconvert --to script example.ipynb
.. _nbconvert: https://nbconvert.readthedocs.io/
Execute notebooks
-----------------
RobotKernel installs a script named ``nbrobot``. It can be used instead of Robot Framework's ``robot`` test runner to execute Robot Framework with ``.ipynb``-extension support:
.. code:: bash
$ nbrobot example.ipynb
Hacking RobotKernel
-------------------
Create and activate a new Python virtual environment:
.. code:: bash
$ venv myenv
$ source myenv/bin/activate
Install Jupyter:
.. code:: bash
$ pip install --upgrade pip setuptools
$ pip install jupyter
Clone this kernel:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
Install the kernel into the virtualenv in develop mode:
.. code:: bash
$ python setup.py develop
$ python -m robotkernel.install
Launch the jupyter:
.. code:: bash
$ jupyter notebook
Reloading the kernel reloads the code.
`Learn more about Jupyter kernel development.`__
__ http://jupyter.readthedocs.io/en/latest/install.html
Nix-shell
---------
This repository includes an opinionated environment for running and developing RobotKernel with Nix_ with `Cachix-powered binary cache`__.
__ https://robots-from-jupyter.cachix.org/
Launch Jupyter Notebook with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")' --run "jupyter notebook"
.. _Nix: https://nixos.org/nix/
Launch JupyterLab with RobotKernel:
.. code:: bash
$ nix-shell -E 'import (fetchTarball https://github.com/robots-from-jupyter/robotkernel/archive/master.tar.gz + "/shell.nix")'
$ jupyter labextension install jupyterlab_robotmode --app-dir=.jupyterlab
$ jupyter lab --app-dir=.jupyterlab
$ exit
Add ``--arg vim true`` to enable `vim bindings`_.
.. _vim bindings: https://github.com/lambdalisue/jupyter-vim-binding
Open development environment with Nix:
.. code:: bash
$ git clone https://github.com/robots-from-jupyter/robotkernel.git
$ cd robotkernel
$ nix-build setup.nix -A env # to generate ./result/bin/python for IDE
$ nix-shell setup.nix -A develop
Changelog
=========
1.6rc1 (2022-04-07)
-------------------
- Fix support for ipywidgets >= 8.0.0rc0
[datakurre]
- Update classic Notebook mode with Robot Framework 5 features
[bollwyvl, datakurre]
- Add pyolite support
[datakurre]
- Add %sticky magic LibraryName -magic to optionally preserve state of global and suite scope libraries between executions
[datakurre]
1.5.1 (2021-09-28)
------------------
- Fix set_parent signature
[martinRenou]
1.5.0 (2021-04-22)
------------------
- Add support for robotframework 4.0
[datakurre]
1.4.0 (2020-04-27)
------------------
- Add support for robotframework 3.2
[datakurre]
- Change kernel mimetype to "text/x-robotframework"
[datakurre]
1.3.0 (2020-01-09)
------------------
- Add jupyterlab-starters' based quick start and tutorial
[datakurre]
- Fix issue where Selenium test or task execution resulted in breaking
exception, because temporary execution directory could not be cleared due to
open geckodriver.log
[datakurre]
1.2.2 (2020-01-05)
------------------
- Fix regression where wrong nbimporter was not automatically imported
[datakurre]
1.2.1 (2019-12-30)
------------------
- Fix issue where data uri images were not displayed on notebook
[datakurre]
- Fix issue where list type suite variables were not correctly restored
[datakurre]
1.2 (2019-12-06)
----------------
- Add support for Robot Framework 3.2a1
[datakurre]
- Add support for displaying multiline text return values
[datakurre]
- Add support for sticky JupyterLibrary webdriver connections
[datakurre]
- Fix issue where updated global variables were overridden from saved
variables from the previous execution
[datakurre]
1.1.1 (2019-12-05)
------------------
- Fix issue where library autocompletion override settings keywords
autocompletion
[datakurre]
1.1.0 (2019-12-05)
------------------
- Add Library autocompletion after Library keyword within Settings
[datakurre]
1.0.2 (2019-12-04)
------------------
- Fix issue where text strings feed to JSON displayed a warning
[datakurre]
- Fix JupyterLab context help support to work when clicked in the middlle of a keyword
[datakurre]
- Fix to close dangling Selenium connections
[datakurre]
1.0.1 (2019-09-19)
------------------
- Fix issue where ${CURDIR} was broken on Windows, because it contained path without
escaped path separators required by Robot Framework
[datakurre]
- Fix issue where suite variable listener reported errors when running robot suites,
because it tried to restore dictionary variables with empty value
[datakurre]
1.0 (2019-09-12)
----------------
- Fix issue where log and report links did not open on JupyterLab 1.0
[datakurre]
1.0rc1 (2019-04-01)
-------------------
- Move tutorials notebooks into notebooks folder
[datakurre]
- Fix WhiteLibrary autocompletion to suggest selectors with :-separator
instead of =-separator
[datakurre]
0.12.2 (2019-03-30)
-------------------
- Fix remaining where keeping state of suite level variables between cell
executions since 0.12.0 caused regression by fixing the listener to ignore
all known built-in variables
[datakurre]
0.12.1 (2019-03-27)
-------------------
- Fix issue where keeping state of suite level variables between cell
executions resulted in errors caused by outdated output directory
from the old variables
[datakurre]
0.12.0 (2019-03-26)
-------------------
New features:
- Add keyword execution widgets below executed keyword cells; Add to toggle
widgets on consecutive executions without code changes
[datakurre]
- Add listener to keep state of suite level variables between robot executions
[datakurre]
- Add IPython display hooks
[datakurre]
New features:
- Add updates to highlighting from ipythonrobotframework
[datakurre]
0.11.0 (2019-01-29)
-------------------
- Add WhiteLibrary state support and interactive element picker
[datakurre]
- Add WhiteLibraryCompanion keyword library to interactively
select elements and click elements with OpenCV templates
[datakurre]
0.10.2 (2019-01-11)
-------------------
- Fix syntax highlighting issue where only the first variable of many was
highlighted
[datakurre]
0.10.1 (2019-01-10)
-------------------
- Update package trove classifiers
[datakurre]
0.10.0 (2019-01-08)
-------------------
Breaking:
- Setuptools 40.5.0 later and Robot Framework 3.1 or later.
[datakurre]
new features:
- Add pregenerated kernel.json in data_files to auto-install robotkernel,
but requiring
[datakurre]
0.9.0 (2019-01-04)
------------------
New features:
- Rewrite status updater to the status of currently run test as
``trobber | test name | keyword name | robot.api.logger.console message``
[datakurre]
- Add embedded log and report to include Download-links at top right corner
[datakurre]
- Add to display the results of the last executed keyword as the notebook
result for the executed code cell
[datakurre]
- Add syntax highlighting for variables and assignment operators
[datakurre]
Bug fixes:
- Fix issue where setup.cfg contained OS specific path separators preventing
build on Windows
[datakurre]
- Fix issue where PNGs were interpreted as APNG on Windows preventing
them from being rendered on Windows
[datakurre]
- Update example notebook to use SeleniumLibrary and SeleniumScreenshots
instead of SeleniumLibrary and Selenium2Screenshots
[datakurre]
- Add to always reload libraries imported from other notebooks
[datakurre]
0.8.0 (2018-12-14)
------------------
- Add to auto-import nbimporter when available to make it possible to
import eg. keyword libraries from Python notebooks
[datakurre]
- Fix issue where nbrobot did support %%python module magic
[datakurre]
0.7.1 (2018-11-20)
------------------
- Add to require robotframework >= 3.1b1 in requires
0.7.0 (2018-10-31)
------------------
Breaking:
- Requires robotframework >= 3.1b1
Other:
- Add to create nbreader and nblibdoc cli to run robot with notebook reader
support
[datakurre]
- Add Selenium completions to sometimes include raw Simmer results with
simplfied id completion results
[datakurre]
- Add proof-of-concept selector completion for Appium and AutoIT libraries
[datakurre]
- Fix screenshot processor to also discover images with absolute path or within
the current working directory
[datakurre]
0.6.3 (2018-10-19)
------------------
This is the last release compatible with robotframework < 3.1
- Remove deprecated replace-flag from kernel installer
[datakurre]
0.6.2 (2018-10-19)
------------------
- Fix compatibility issue with robotframework < 3.1
[datakurre]
0.6.1 (2018-10-19)
------------------
- Fix issue where kernel installation produced broken kernel.json on Windows
[datakurre]
0.6.0 (2018-10-18)
------------------
- Revert data source path from temporary directory into current working
directory to allow local libraries and resources work in the usual use cases
[datakurre]
- Add experimental Simmerjs based CSS-selector builder and element picker with
when auto-completion is called with empty "css:"-selector
[datakurre]
- Add experimental Selenium selector auto-completion
[datakurre]
- Add dummy variable completion with only variables from current suite without
context knowledge
[datakurre]
- Add inline documentation links to Robot Framework User Guide for structural
keywords
[datakurre]
0.5.4 (2018-10-09)
------------------
- Fix issue where single term keywords got no completions
[datakurre]
0.5.3 (2018-10-09)
------------------
- Update README
[datakurre]
0.5.1 (2018-10-08)
------------------
- Auto completion and keyword doc inspection enhancements
[datakurre]
0.5.0 (2018-10-08)
------------------
- Add auto-completion, keyword doc inspection and support for
replacing and deleting cell history on Jupyter lab
[datakurre]
0.4.0 (2018-09-26)
------------------
- Add support for robotframework 3.1a2
[datakurre]
- Add support for reporting RPA suites with "Tasks" instead of "Tests"
[datakurre]
0.3.5 (2018-09-25)
------------------
- Update README with notebook execution instructions
[datakurre]
0.3.4 (2018-09-25)
------------------
- Update README
[datakurre]
0.3.3 (2018-09-25)
------------------
- Note on README that Log | Report -links require trusting the notebook
[datakurre]
- Fix to wrap test execution updates with '<pre>' for better readability
[datakurre]
0.3.2 (2018-09-25)
------------------
- Change to always send display data updates in text/html to workaround a bug
that caused 'undefined' to be rendered in JupyterLab
[datakurre]
0.3.1 (2018-09-24)
------------------
- Update README
[datakurre]
0.3.0 (2018-09-23)
------------------
- First release.
[datakurre]
+0
-1
src/robotkernel.egg-info/SOURCES.txt

@@ -1,2 +0,1 @@

.gitignore
.readthedocs.yml

@@ -3,0 +2,0 @@ CHANGELOG.rst

+12
-2
src/robotkernel/executors.py

@@ -156,3 +156,3 @@ # -*- coding: utf-8 -*-

# noinspection PyTypeChecker
display(ipywidgets.widgets.VBox([ui, out]), display_id=display_id)
display(ipywidgets.widgets.VBox([ui, out]), display_id=f"{display_id}.widgets")

@@ -170,5 +170,7 @@

suite_ = build_suite(code, {})
counter = 0
for keyword in suite_.resource.keywords:
name = keyword.name
arguments = []
counter += 1
for arg in keyword.args:

@@ -181,3 +183,11 @@ if "=" in arg:

inject_ipywidget(
kernel, code, history, listeners, silent, display_id, rpa, name, arguments
kernel,
code,
history,
listeners,
silent,
f"{display_id}.{counter:02}",
rpa,
name,
arguments,
)

@@ -184,0 +194,0 @@ 

+23
-23
src/robotkernel/selectors.py

@@ -157,3 +157,3 @@ # -*- coding: utf-8 -*-

script, arguments = get_element_highlight_script(
[], driver.find_elements_by_css_selector("[data-robotkernel]")
[], driver.find_elements("css selector", "[data-robotkernel]")
)

@@ -179,3 +179,3 @@ except InvalidSessionIdException as e:

styles = 'style[data-name="robotkernel"]'
if not driver.find_elements_by_css_selector(styles):
if not driver.find_elements("css selector", styles):
with pkg_resources.resource_stream(

@@ -200,3 +200,3 @@ "robotkernel", "resources/simmerjs/simmer.js"

script, arguments = get_element_highlight_script(
results, driver.find_elements_by_css_selector("[data-robotkernel]")
results, driver.find_elements("css selector", "[data-robotkernel]")
)

@@ -326,7 +326,7 @@ driver.execute_script(script, *arguments)

if needle:
results = driver.find_elements_by_css_selector(
f'[id="{needle}"]'
) or driver.find_elements_by_css_selector(f'[id*="{needle}"]')
results = driver.find_elements(
"css selector", f'[id="{needle}"]'
) or driver.find_elements("css selector", f'[id*="{needle}"]')
else:
results = driver.find_elements_by_xpath("//*[@id]")
results = driver.find_elements("xpath", "//*[@id]")
for result in visible_or_all(results):

@@ -342,7 +342,7 @@ id_ = result.get_attribute("id")

if needle:
results = driver.find_elements_by_xpath(
f"//*[" f'contains(@resource-id, "{needle}")' f"]"
results = driver.find_elements(
"xpath", f"//*[" f'contains(@resource-id, "{needle}")' f"]"
)
else:
results = driver.find_elements_by_xpath("//*[@resource-id]")
results = driver.find_elements("xpath", "//*[@resource-id]")
for result in visible_or_all(results):

@@ -358,7 +358,7 @@ id_ = result.get_attribute("resource-id")

if needle:
results = driver.find_elements_by_css_selector(
f'[name="{needle}"]'
) or driver.find_elements_by_css_selector(f'[name*="{needle}"]')
results = driver.find_elements(
"css selector", f'[name="{needle}"]'
) or driver.find_elements("css selector", f'[name*="{needle}"]')
else:
results = driver.find_elements_by_xpath("//*[@name]")
results = driver.find_elements("xpath", "//*[@name]")
for result in visible_or_all(results):

@@ -410,3 +410,3 @@ name = result.get_attribute("name")

if needle:
results = driver.find_elements_by_css_selector(needle)
results = driver.find_elements("css selector", needle)
for result in visible_or_all(results):

@@ -438,3 +438,3 @@ id_ = result.get_attribute("id")

if needle:
results = driver.find_elements_by_css_selector(needle)
results = driver.find_elements("css selector", needle)
for result in visible_or_all(results):

@@ -459,5 +459,5 @@ id_ = result.get_attribute("id")

if needle:
results = driver.find_elements_by_partial_link_text(needle)
results = driver.find_elements("partial link text", needle)
else:
results = driver.find_elements_by_xpath("//a")
results = driver.find_elements("xpath", "//a")
for result in visible_or_all(results):

@@ -475,3 +475,3 @@ if result.text:

if needle:
results = driver.find_elements_by_xpath(needle)
results = driver.find_elements("xpath", needle)
for result in visible_or_all(results):

@@ -496,9 +496,9 @@ id_ = result.get_attribute("id")

if IS_TEXT.match(needle):
results = driver.find_elements_by_xpath(
f"//*[" f'contains(@text, "{needle}")' f"]"
results = driver.find_elements(
"xpath", f"//*[" f'contains(@text, "{needle}")' f"]"
)
elif needle:
results = driver.find_elements_by_xpath(needle)
results = driver.find_elements("xpath", needle)
else:
results = driver.find_elements_by_xpath("//*[@resource-id]")
results = driver.find_elements("xpath", "//*[@resource-id]")
for result in visible_or_all(results):

@@ -505,0 +505,0 @@ id_ = result.get_attribute("resource-id")

-35
.gitignore
syntax: glob
*.egg-info
*.pyc
*.doit.db
*.log
*.tsbuildinfo
_/
_pypi.ts
lib/
pypi/
dist/
labextension/
node_modules/
.cache
.eggs
.DS_Store
.idea
.ipynb_checkpoints
.jupyter
.jupyterlab
.jupyter-config
.pytest_cache
/build/
/examples/button.png
/geckodriver.log
/html/
/log.html
/output.xml
/report.html
/result
/selenium-screenshot-*.png
/src/jupyterlab_robotmode/lib/
/src/jupyterlab_robotmode/node_modules/
/tmp/
/Untitle*.ipynb
atest/Test Robot Notebook.ipynb

Sorry, the diff of this file is not supported yet