Merge pull request #82 from executablebooks/prefix-regexes

Author: choldgraf

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+ignore=E203,W503

.github/workflows/integration.yml

@@ -4,6 +4,45 @@ on: [push, pull_request]
 
 jobs:
 
+  pre-commit:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        git submodule update --init
+        pip install -e .[code_style]
+    - name: Run pre-commit
+      run: |
+        pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+
+
+  test_js:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm test
+      env:
+        CI: true
+
   docs:
 
     runs-on: ubuntu-latest
@@ -32,7 +71,7 @@ jobs:
   publish:
 
     name: Publish to PyPi
-    needs: [docs]
+    needs: [pre-commit, docs]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -108,3 +108,5 @@ _build/
 
 # VS code config
 .vscode
+
+node_modules/

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# Install pre-commit hooks via
+# pre-commit install
+
+exclude: >
+    (?x)^(
+      \.vscode/settings\.json
+    )$
+
+repos:
+
+  - repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    - id: check-json
+    - id: check-yaml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+    - id: flake8
+
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black

doc/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -19,14 +19,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Sphinx Copybutton'
-copyright = '2018, Chris Holdgraf'
-author = 'Chris Holdgraf'
+project = "Sphinx Copybutton"
+copyright = "2018, Executable Books Project"
+author = "Executable Books Project"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -38,19 +38,19 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx_copybutton']
+extensions = ["sphinx_copybutton", "IPython.sphinxext.ipython_directive"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -62,18 +62,18 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 # html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -85,7 +85,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -98,7 +98,8 @@
 # html_sidebars = {}
 
 # CopyButton configuration
-copybutton_prompt_text = ">>> "
+copybutton_prompt_text = ">>> |\\\\$ |\\[\\d*\\]: |\\.\\.\\.: "
+copybutton_prompt_is_regexp = True
 # Switches for testing but shouldn't be activated in the live docs
 # copybutton_only_copy_prompt_lines = False
 # copybutton_remove_prompts = False
@@ -109,7 +110,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SphinxCopybuttondoc'
+htmlhelp_basename = "SphinxCopybuttondoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -118,15 +119,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -136,8 +134,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'SphinxCopybutton.tex', 'Sphinx Copybutton Documentation',
-     'Chris Holdgraf', 'manual'),
+    (
+        master_doc,
+        "SphinxCopybutton.tex",
+        "Sphinx Copybutton Documentation",
+        "Executable Books Project",
+        "manual",
+    )
 ]
 
 
@@ -146,8 +149,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'sphinxcopybutton', 'Sphinx Copybutton Documentation',
-     [author], 1)
+    (master_doc, "sphinxcopybutton", "Sphinx Copybutton Documentation", [author], 1)
 ]
 
 
@@ -157,7 +159,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'SphinxCopybutton', 'Sphinx Copybutton Documentation',
-     author, 'SphinxCopybutton', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "SphinxCopybutton",
+        "Sphinx Copybutton Documentation",
+        author,
+        "SphinxCopybutton",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]

doc/index.rst

@@ -135,6 +135,34 @@ use the following configuration:
 
     copybutton_prompt_text = ">>> "
 
+Using regexp prompt identifiers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If your prompts are more complex than a single string, then you can use a regexp to match with.
+
+.. code-block:: python
+
+   copybutton_prompt_text = "\\[\\d*\\]: |\\.\\.\\.: "
+   copybutton_prompt_is_regexp = True
+
+For example when using ipython prompts with continuations:
+
+.. code-block:: restructuredtext
+
+   .. code-block:: ipython
+
+      [1]: first
+      ...: continuation
+      output
+      [2]: second
+
+.. code-block:: ipython
+
+   [1]: first
+   ...: continuation
+   output
+   [2]: second
+
 Configure whether *only* lines with prompts are copied
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -210,6 +238,64 @@ pull to your computer and install locally with ``pip``::
 
 **Pull requests** and **Issues** are absolutely welcome!
 
+The package is tested for three things (see ``.github/workflows/integration.yml``):
+
+code style
+----------
+
+To adhere to this code style install the package with `pre-commit <https://pre-commit.com/>`__:
+
+.. code-block:: console
+
+   $ pip install .[code_style]
+
+Then you can run:
+
+.. code-block:: console
+
+   $ pre-commit run --all
+
+Or setup pre-commit to run on code commits:
+
+.. code-block:: console
+
+   $ pre-commit install
+
+JavaScript unit testing
+-----------------------
+
+Install the test dependencies with `npm <https://www.npmjs.com/>`__:
+
+.. code-block:: console
+
+   $ npm install ci
+
+Then run the tests:
+
+.. code-block:: console
+
+   $ npm test
+
+.. note::
+
+   NodeJS >= 12 is required
+
+Documentation builds
+--------------------
+
+Install the package:
+
+.. code-block:: console
+
+   $ pip install .
+
+Then run the docs build:
+
+.. code-block:: console
+
+   $ cd doc
+   $ make html
+
 .. toctree::
    :maxdepth: 1
 

doc/requirements.txt

@@ -1,4 +1,5 @@
 sphinx
+ipython
 
 # Install ourselves
-.
+.