|
| 1 | +{ |
| 2 | + "cells": [ |
| 3 | + { |
| 4 | + "cell_type": "markdown", |
| 5 | + "metadata": {}, |
| 6 | + "source": [ |
| 7 | + "# INSTALL\n", |
| 8 | + "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", |
| 9 | + "\n", |
| 10 | + "> _Sorry for the mess, haven't actually shipped anything yet... but the [DEV](#DEV) install does kinda work already_" |
| 11 | + ] |
| 12 | + }, |
| 13 | + { |
| 14 | + "cell_type": "markdown", |
| 15 | + "metadata": {}, |
| 16 | + "source": [ |
| 17 | + "## TODO `conda`" |
| 18 | + ] |
| 19 | + }, |
| 20 | + { |
| 21 | + "cell_type": "markdown", |
| 22 | + "metadata": {}, |
| 23 | + "source": [ |
| 24 | + "## TODO `pip`" |
| 25 | + ] |
| 26 | + }, |
| 27 | + { |
| 28 | + "cell_type": "markdown", |
| 29 | + "metadata": {}, |
| 30 | + "source": [ |
| 31 | + "## TODO `pipenv`" |
| 32 | + ] |
| 33 | + }, |
| 34 | + { |
| 35 | + "cell_type": "markdown", |
| 36 | + "metadata": {}, |
| 37 | + "source": [ |
| 38 | + "## TODO `poetry`" |
| 39 | + ] |
| 40 | + }, |
| 41 | + { |
| 42 | + "cell_type": "markdown", |
| 43 | + "metadata": {}, |
| 44 | + "source": [ |
| 45 | + "## TODO `anaconda-project`" |
| 46 | + ] |
| 47 | + }, |
| 48 | + { |
| 49 | + "cell_type": "markdown", |
| 50 | + "metadata": {}, |
| 51 | + "source": [ |
| 52 | + "## `master`\n", |
| 53 | + "`JupyterLibrary` is under active development, and is heavily invested in `conda` because of the complexity of managing browser execution dependencies. But `conda` (rightly) makes it hard to install Random Repos from the Internet, so you'll need a bit of `pip`, too. \n", |
| 54 | + "\n", |
| 55 | + "Here's a complete setup:\n", |
| 56 | + "```shell\n", |
| 57 | + "conda create \\\n", |
| 58 | + " -n testing-jupyter \\ # as good a name as any\n", |
| 59 | + " python=3 # 2020 is right around the corner\n", |
| 60 | + "\n", |
| 61 | + "conda activate testing-jupyter # get on the right PATH\n", |
| 62 | + "\n", |
| 63 | + "conda install \\\n", |
| 64 | + " -c conda-forge \\ # can't get all these from Austin\n", |
| 65 | + " jupyterlab \\ # mostly this\n", |
| 66 | + " robotframework-seleniumlibrary \\ # includes robotframework... and selenium\n", |
| 67 | + " geckodriver \\ # moz:\\\\a FTW\n", |
| 68 | + " python-chromedriver-binary # for the rest of the marketshare\n", |
| 69 | + "\n", |
| 70 | + "pip install --no-deps \\ # don't want any surprises\n", |
| 71 | + " nteract_on_jupyter \\ # now with more ✨\n", |
| 72 | + " git+http://github.com/bollwyvl/robotframework-jupyterlibrary#egg=JupyterLibrary\n", |
| 73 | + "```\n", |
| 74 | + "Also take a gander at this project's `environment.yml` or `anaconda-project.yml` at that URL there." |
| 75 | + ] |
| 76 | + }, |
| 77 | + { |
| 78 | + "cell_type": "markdown", |
| 79 | + "metadata": {}, |
| 80 | + "source": [ |
| 81 | + "## DEV\n", |
| 82 | + "- get Firefox\n", |
| 83 | + "- get Miniconda\n", |
| 84 | + "- clone\n", |
| 85 | + " \n", |
| 86 | + " git clone http://github.com/bollwyvl/robotframework-jupyterlibrary\n", |
| 87 | + "\n", |
| 88 | + "- update and activate\n", |
| 89 | + "\n", |
| 90 | + " conda env update\n", |
| 91 | + " conda activate robotframework-jupyterlibrary\n", |
| 92 | + "\n", |
| 93 | + "- then\n", |
| 94 | + "\n", |
| 95 | + " pip install -e . --no-deps --ignore-installed\n", |
| 96 | + "\n", |
| 97 | + "- run the tests\n", |
| 98 | + "\n", |
| 99 | + " python -m scripts.atest" |
| 100 | + ] |
| 101 | + }, |
| 102 | + { |
| 103 | + "cell_type": "code", |
| 104 | + "execution_count": null, |
| 105 | + "metadata": {}, |
| 106 | + "outputs": [], |
| 107 | + "source": [] |
| 108 | + } |
| 109 | + ], |
| 110 | + "metadata": { |
| 111 | + "kernelspec": { |
| 112 | + "display_name": "Python 3", |
| 113 | + "language": "python", |
| 114 | + "name": "python3" |
| 115 | + }, |
| 116 | + "language_info": { |
| 117 | + "codemirror_mode": { |
| 118 | + "name": "ipython", |
| 119 | + "version": 3 |
| 120 | + }, |
| 121 | + "file_extension": ".py", |
| 122 | + "mimetype": "text/x-python", |
| 123 | + "name": "python", |
| 124 | + "nbconvert_exporter": "python", |
| 125 | + "pygments_lexer": "ipython3", |
| 126 | + "version": "3.7.1" |
| 127 | + }, |
| 128 | + "nteract": { |
| 129 | + "version": "nteract-on-jupyter@0.35.4" |
| 130 | + } |
| 131 | + }, |
| 132 | + "nbformat": 4, |
| 133 | + "nbformat_minor": 2 |
| 134 | +} |
0 commit comments