From f45af65a01b56ad58b2516d2d8dfec785c994160 Mon Sep 17 00:00:00 2001 From: Nicholas Bollweg Date: Fri, 21 Dec 2018 14:39:09 -0500 Subject: [PATCH] update with docs stuff --- README.md | 41 ++++++++++++++++++++++---------------- anaconda-project.yml | 6 ++++++ docs/INSTALL.ipynb | 32 ++++++----------------------- src/JupyterLibrary/core.py | 4 +--- 4 files changed, 37 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 4a276737..7edc0d40 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,38 @@ [Robot Framework]: http://robotframework.org [Jupyter]: https://jupyter.org -| docs | demo | pipes | -|:-----------------------:|:---------------------------:|:-----------------------------:| -| [![docs-badge][]][docs] | [![binder-badge][]][binder] | [![pipeline-badge]][pipeline] | +| pip | conda | docs | demo | pipes | +|:-----------------------:|:-----------------------:|:-----------------------:|:---------------------------:|:-----------------------------:| +| [![pip-badge][]][pip] | TODO | [![docs-badge][]][docs] | [![binder-badge][]][binder] | [![pipeline-badge]][pipeline] | # Using Write `.robot` files that use `JupyterLibrary` keywords. - *** Settings *** - Library JupyterLibrary - Suite Setup Wait for New Jupyter Server to be Ready - 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 +```robotframework +*** Settings *** +Library JupyterLibrary +Suite Setup Wait for New Jupyter Server to be Ready +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 -> _TODO: release on pypi, conda-forge_ +```bash +pip install robotframework-jupyterlibrary +``` +> _TODO: release on conda-forge_ ## Development Installation @@ -71,6 +76,8 @@ from a number of other projects: [pipeline-badge]: https://dev.azure.com/nickbollweg/nickbollweg/_apis/build/status/bollwyvl.robotframework-jupyterlibrary [pipeline]: https://dev.azure.com/nickbollweg/nickbollweg/_build/latest?definitionId=2 [docs-badge]: https://readthedocs.org/projects/robotframework-jupyterlibrary/badge/?version=latest +[pip-badge]: https://img.shields.io/pypi/v/robotframework-jupyterlibrary.svg +[pip]: https://pypi.org/project/robotframework-jupyterlibrary [docs]: https://robotframework-jupyterlibrary.readthedocs.io [SeleniumLibrary]: https://github.com/robotframework/SeleniumLibrary diff --git a/anaconda-project.yml b/anaconda-project.yml index b798c2f0..0a66452b 100644 --- a/anaconda-project.yml +++ b/anaconda-project.yml @@ -83,6 +83,10 @@ commands: unix: sphinx-build -M html docs _artifacts/docs env_spec: rfjl37 + publish:pypi: + unix: twine upload --repository-url https://upload.pypi.org/legacy/ _artifacts/{sdist,wheel}/* + env_spec: rfjl37 + env_specs: robotframework-jupyterlibrary: packages: @@ -107,12 +111,14 @@ env_specs: channels: - conda-forge - defaults + rfjl37: inherit_from: - robotframework-jupyterlibrary packages: - python >=3.7,<3.8 - nodejs >=8.12,<9 + - twine win_rfjl37: inherit_from: diff --git a/docs/INSTALL.ipynb b/docs/INSTALL.ipynb index ffadfeeb..245c172a 100644 --- a/docs/INSTALL.ipynb +++ b/docs/INSTALL.ipynb @@ -5,44 +5,24 @@ "metadata": {}, "source": [ "# INSTALL\n", - "Installing `JupyterLibrary` will bring along Robot Framework and SeleniumLibrary. Jupyter components, like `notebook`, `jupyterlab` and `nteract_on_jupyter`, and browser executors (e.g. `chromedriver`, `geckodriver`) and various utilities (e.g. `nodejs`) are up to you, depending on what you want to test. Here are some examples.\n", - "\n", - "> _Sorry for the mess, haven't actually shipped anything yet... but the [DEV](#DEV) install does kinda work already_" + "Installing `JupyterLibrary` will bring along Robot Framework and SeleniumLibrary. Jupyter components, like `notebook`, `jupyterlab` and `nteract_on_jupyter`, and browser executors (e.g. `chromedriver`, `geckodriver`) and various utilities (e.g. `nodejs`) are up to you, depending on what you want to test. Here are some examples." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "## TODO `conda`" + "## `pip`\n", + "```bash\n", + "pip install robotframework-jupyterlibrary\n", + "```" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ - "## TODO `pip`" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## TODO `pipenv`" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## TODO `poetry`" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "## TODO `anaconda-project`" + "## TODO `conda`" ] }, { diff --git a/src/JupyterLibrary/core.py b/src/JupyterLibrary/core.py index 6d6c0617..23d677be 100644 --- a/src/JupyterLibrary/core.py +++ b/src/JupyterLibrary/core.py @@ -71,9 +71,7 @@ def start_suite(self, name, attrs): resources = [] for common in COMMON: - resources += [ - "JupyterLibrary/common/{}".format(basename(common)) - ] + resources += ["JupyterLibrary/common/{}".format(basename(common))] for client in CLIENTS: for path in glob(join(client, "*.robot")):