some more linting, readme, etc

bollwyvl · bollwyvl · commit a536fc81b74d · 2018-12-14T23:28:34.000-05:00
diff --git a/README.md b/README.md
@@ -1,37 +1,59 @@
 # robotframework-jupyterlibrary
-> A Robot Framework library for testing Jupyter end-user applications and extensions
+> A [Robot Framework][] library for automating (testing of) [Jupyter][] end-user applications and extensions
+
+[Robot Framework]: http://robotframework.org
+[Jupyter]: https://jupyter.org
 
 [![binder-badge][]][binder] [![pipeline-badge]][pipeline]
 
-> _TODO: rtd, pip, conda_
+# 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
+
+See the [acceptance tests][] for examples.
+
 
 # Installation
+> _TODO: release on pypi, conda-forge_
 
 ## Development Installation
+
 - get Firefox
-- get Miniconda
-- update and activate
-```bash
-conda env update
-conda activate robotframework-jupyterlibrary
-```
-- then
-```bash
-pip install -e . --no-deps --ignore-installed
-```
-- run the tests
-```
-python -m scripts.atest
-```
+  - Chrome works, too, but more fickle
+- get [Miniconda3][] (as in Python 3.6+)
+- clone this repo...
 
-# Using
-> _TODO: Figure out a documentation strategy that works with
-         janky-imported resources_
+      git clone https://github.com/bollwyvl/robotframework-jupyterlibrary
+      cd robotframework-jupyterlibrary
+
+- update and activate...
+
+      conda env update
+      conda activate robotframework-jupyterlibrary
+
+- then...
+
+      pip install -e . --no-deps --ignore-installed
 
-Write `.robot` files that use `JupyterLibrary` keywords. See the
-[acceptance tests](./atest/acceptance) for examples.
+- run the tests...
 
+      python -m scripts.atest
 
+[acceptance tests]: https://github.com/bollwyvl/robotframework-jupyterlab
+[Miniconda3]: https://conda.io/miniconda.html
 [binder-badge]: https://mybinder.org/badge_logo.svg
 [binder]: https://mybinder.org/v2/gh/bollwyvl/robotframework-jupyterlibrary/master?urlpath=lab/tree/README.md
 [pipeline-badge]: https://dev.azure.com/nickbollweg/nickbollweg/_apis/build/status/bollwyvl.robotframework-jupyterlibrary
diff --git a/docs/INSTALL.ipynb b/docs/INSTALL.ipynb
@@ -83,20 +83,20 @@
     "- get Miniconda\n",
     "- clone\n",
     "  \n",
-    "    git clone http://github.com/bollwyvl/robotframework-jupyterlibrary\n",
+    "        git clone http://github.com/bollwyvl/robotframework-jupyterlibrary\n",
     "\n",
     "- update and activate\n",
     "\n",
-    "    conda env update\n",
-    "    conda activate robotframework-jupyterlibrary\n",
+    "        conda env update\n",
+    "        conda activate robotframework-jupyterlibrary\n",
     "\n",
     "- then\n",
     "\n",
-    "    pip install -e . --no-deps --ignore-installed\n",
+    "        pip install -e . --no-deps --ignore-installed\n",
     "\n",
     "- run the tests\n",
     "\n",
-    "    python -m scripts.atest"
+    "        python -m scripts.atest"
    ]
   },
   {
diff --git a/docs/KEYWORDS.ipynb b/docs/KEYWORDS.ipynb
@@ -25,7 +25,20 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 6,
+   "metadata": {
+    "jupyter": {
+     "source_hidden": true
+    }
+   },
+   "outputs": [],
+   "source": [
+    "iframe = lambda url: __import__(\"IPython\").display.HTML(f\"\"\"<iframe src=\"_static/{url}.html\" id=\"{url}\" width=\"100%\"></iframe>\"\"\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
    "metadata": {
     "jupyter": {
      "source_hidden": true
@@ -35,27 +48,18 @@
     {
      "data": {
       "text/html": [
-       "\n",
-       "        <iframe\n",
-       "            width=\"100%\"\n",
-       "            height=\"\"\n",
-       "            src=\"_static/JupyterLibrary.html\"\n",
-       "            frameborder=\"0\"\n",
-       "            allowfullscreen\n",
-       "        ></iframe>\n",
-       "        "
+       "<iframe src=\"_static/JupyterLibrary.html\" id=\"JupyterLibrary\" width=\"100%\"></iframe>"
       ],
       "text/plain": [
-       "<IPython.lib.display.IFrame at 0x7ff15c58c4a8>"
+       "<IPython.core.display.HTML object>"
       ]
      },
-     "execution_count": 3,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "iframe = lambda url: __import__(\"IPython\").display.IFrame(f\"_static/{url}.html\", width=\"100%\", height=\"\")\n",
     "iframe(\"JupyterLibrary\")"
    ]
   },
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -43,6 +43,7 @@ a {
 
 iframe {
   height: 95vh;
+  border: 0;
 }
 
 a:hover, a:active {
diff --git a/docs/index.ipynb b/docs/index.ipynb
@@ -11,7 +11,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "> A Robot Framework library for testing Jupyter end-user applications and extensions"
+    "> A [Robot Framework][] library for automating (testing of) [Jupyter][] end-user applications and extensions\n",
+    "\n",
+    "[Robot Framework]: http://robotframework.org\n",
+    "[Jupyter]: https://jupyter.org"
    ]
   },
   {
@@ -23,17 +26,17 @@
     "```robotframework\n",
     "*** Settings ***\n",
     "Library           JupyterLibrary\n",
-    "Suite Setup    Wait for New Jupyter Server to be Ready\n",
+    "Suite Setup       Wait for New Jupyter Server to be Ready\n",
     "Test Teardown     Reset JupyterLab and Close\n",
     "Suite Teardown    Terminate All Jupyter Servers\n",
     "\n",
     "*** Test Cases ***\n",
-    "IPython Notebook\n",
+    "A Notebook in JupyterLab\n",
     "    Open JupyterLab\n",
     "    Launch a new JupyterLab Document\n",
-    "    Add and Run JupyterLab Code Cell    print(\"hello world\")\n",
+    "    Add and Run JupyterLab Code Cell\n",
     "    Wait Until JupyterLab Kernel Is Idle\n",
-    "    Capture Page Screenshot    ipython.png\n",
+    "    Capture Page Screenshot\n",
     "```"
    ]
   },
diff --git a/scripts/lint.py b/scripts/lint.py
@@ -1,5 +1,8 @@
+from pathlib import Path
 from subprocess import check_call
 
+from nbformat import NO_CONVERT, read, write
+
 
 PY_SRC = ["src", "setup.py", "scripts", "docs"]
 RF_SRC = ["atest", "src"]
@@ -13,6 +16,20 @@ def lint():
     for src in RF_SRC:
         check_call(["python", "-m", "robot.tidy", "-r", src])
 
+    for nbp in (Path(__file__).parent / "docs").rglob("*.ipynb"):
+        nbf = read(nbp, NO_CONVERT)
+        changed = False
+        for cell in nbf:
+            if cell.cell_type == "code_cell":
+                if cell.outputs:
+                    cell.outputs = []
+                    changed = True
+                if cell.execution_count:
+                    cell.execution_count = None
+                    changed = True
+        if changed:
+            write(nbf, nbp)
+
 
 if __name__ == "__main__":
     lint()
diff --git a/setup.cfg b/setup.cfg
@@ -1,7 +1,8 @@
 [metadata]
 name = robotframework-jupyterlibrary
-description = A Robot Framework library for testing Jupyter end-user applications and extensions
-long_description = file: README.md, CHANGELOG.md
+description = A Robot Framework library for automating (testing of) Jupyter end-user applications and extensions
+long_description = file: README.md
+long_description_content_type = text/markdown
 url = https://github.com/robots-from-jupyter/robotframework-jupyterlibrary
 author = Nicholas Bollweg
 author_email = nick.bollweg@gmail.com

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ a {`
`43`	`43`
`44`	`44`	`iframe {`
`45`	`45`	`height: 95vh;`
	`46`	`+ border: 0;`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`a:hover, a:active {`