Updated files with 'repo_helper'.

domdfcoding · domdfcoding · commit 029a847dd983 · 2020-07-27T21:28:01.000Z
diff --git a/.dependabot/config.yml b/.dependabot/config.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 
 version: 1
diff --git a/.github/auto_assign.yml b/.github/auto_assign.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 
 addReviewers: true
diff --git a/.github/stale.yml b/.github/stale.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 # Configuration for probot-stale - https://github.com/probot/stale
 ---
 
diff --git a/.github/workflows/docs_test_action.yml b/.github/workflows/docs_test_action.yml
@@ -1,3 +1,4 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 name: "Docs Check"
 on:
diff --git a/.github/workflows/octocheese.yml b/.github/workflows/octocheese.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 
 name: "GitHub Releases"
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 name: Windows Tests
 
@@ -33,7 +33,7 @@ jobs:
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade tox tox-gh-actions
+          python -m pip install --upgrade tox tox-gh-actions virtualenv
 
       - name: "Run Tests for Python ${{ matrix.python-version }}"
         run: "python -m tox"
diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 name: macOS Tests
 
@@ -33,7 +33,7 @@ jobs:
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade tox tox-gh-actions
+          python -m pip install --upgrade tox tox-gh-actions virtualenv
 
       - name: "Run Tests for Python ${{ matrix.python-version }}"
         run: "python -m tox"
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,9 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 __pycache__/
 *.py[cod]
 *$py.class
-*.so.Python
+*.so
+.Python
 build/
 develop-eggs/
 dist/
diff --git a/.isort.cfg b/.isort.cfg
@@ -2,8 +2,8 @@
 [settings]
 line_length = 115
 force_to_top = True
-indent = Tab
-multi_line_output = 3
+indent = "		"
+multi_line_output = 8
 import_heading_stdlib = stdlib
 import_heading_thirdparty = 3rd party
 import_heading_firstparty = this package
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,23 +1,31 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 
 repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.4.0
    hooks:
     - id: check-added-large-files
+    - id: check-ast
     - id: check-byte-order-marker
     - id: check-case-conflict
     - id: check-docstring-first
     - id: check-executables-have-shebangs
     - id: check-json
+    - id: check-merge-conflict
     - id: check-symlinks
+    - id: check-toml
     - id: check-vcs-permalinks
     - id: check-yaml
     - id: detect-private-key
     - id: end-of-file-fixer
-    - id: requirements-txt-fixer
     - id: trailing-whitespace
+    - id: mixed-line-ending
+
+ - repo: https://github.com/domdfcoding/pre-commit-hooks
+   rev: v0.0.1
+   hooks:
+    - id: requirements-txt-sorter
 
  - repo: https://github.com/pre-commit/pygrep-hooks
    rev: v1.5.1
@@ -31,12 +39,18 @@ repos:
     - id: pyupgrade
       args: [--py36-plus]
 
+ - repo: https://github.com/timothycrosley/isort
+   rev: 5.1.4
+   hooks:
+    - id: isort
+      exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
+
  - repo: https://github.com/pre-commit/mirrors-yapf
    rev: v0.30.0
    hooks:
     - id: yapf
       exclude: ^(doc-source/conf|__pkginfo__|make_conda_recipe|setup)\.py$
-
+      args: ["--in-place"]
 
  - repo: https://github.com/Lucas-C/pre-commit-hooks
    rev: v1.1.7
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 # Read the Docs configuration file
 ---
 
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,4 @@
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 ---
 
 language: python
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,72 @@
+.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
+
+==============
+Contributing
+==============
+
+``notebook2script`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
+
+Install ``pre-commit`` with ``pip`` and install the git hook:
+
+.. code-block:: bash
+
+	$ python -m pip install pre-commit
+	$ pre-commit install
+
+
+Coding style
+--------------
+
+`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
+
+``yapf`` and ``isort`` can be run manually via ``pre-commit``:
+
+.. code-block:: bash
+
+	$ pre-commit run yapf -a
+	$ pre-commit run isort -a
+
+
+The complete autoformatting suite can be run with ``pre-commit``:
+
+.. code-block:: bash
+
+	$ pre-commit run -a
+
+
+Automated tests
+-------------------
+
+Tests are run with ``tox`` and ``pytest``. To run tests for a specific Python version, such as Python 3.6, run:
+
+.. code-block:: bash
+
+	$ tox -e py36
+
+
+To run tests for all Python versions, simply run:
+
+.. code-block:: bash
+
+	$ tox
+
+
+Type Annotations
+-------------------
+
+Type annotations are checked using ``mypy``. Run ``mypy`` using ``tox``:
+
+.. code-block:: bash
+
+	$ tox -e mypy
+
+
+
+Build documentation locally
+------------------------------
+
+The documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
+
+.. code-block:: bash
+
+	$ tox -e docs
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -2,5 +2,5 @@ include __pkginfo__.py
 include LICENSE
 include requirements.txt
 recursive-exclude **/__pycache__ *
-recursive-include notebook2script/ *.pyi
+recursive-include notebook2script *.pyi
 include notebook2script/py.typed
diff --git a/__pkginfo__.py b/__pkginfo__.py
@@ -1,4 +1,4 @@
-#  This file is managed by `repo_helper`. Don't edit it directly
+#  This file is managed by 'repo_helper'. Don't edit it directly.
 #  Copyright (C) 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 #
 #  This file is distributed under the same license terms as the program it came with.
diff --git a/doc-source/Building.rst b/doc-source/Building.rst
diff --git a/doc-source/Source.rst b/doc-source/Source.rst
@@ -1,8 +1,8 @@
-*******************************
+=========================
 Downloading source code
-*******************************
+=========================
 
-The ``notebook2script`` source code resides on publicly accessible GitHub servers,
+The ``notebook2script`` source code is available on GitHub,
 and can be accessed from the following URL: https://github.com/domdfcoding/notebook2script"
 
 If you have ``git`` installed, you can clone the repository with the following command:
@@ -25,3 +25,17 @@ If you have ``git`` installed, you can clone the repository with the following c
     :alt: Downloading a 'zip' file of the source code.
 
     Downloading a 'zip' file of the source code
+
+
+Building from source
+-----------------------
+
+The recommended way to build ``notebook2script`` is to use `tox <https://tox.readthedocs.io/en/latest/>`_:
+
+.. prompt:: bash
+
+	tox -e build
+
+The source and wheel distributions will be in the directory ``dist``.
+
+If you wish, you may also use `pep517.build <https://pypi.org/project/pep517/>`_ or another :pep:`517`-compatible build tool.
diff --git a/doc-source/_static/style.css b/doc-source/_static/style.css
@@ -1,5 +1,13 @@
-/* This file is managed by `repo_helper`. Don't edit it directly */
+/* This file is managed by 'repo_helper'. Don't edit it directly. */
 
-.wy-nav-content {max-width: 900px !important;}
+.wy-nav-content {
+	max-width: 1200px !important;
+}
 
-li p:last-child { margin-bottom: 12px !important;}
+li p:last-child {
+	margin-bottom: 12px !important;
+}
+
+html {
+	scroll-behavior: smooth;
+}
diff --git a/doc-source/_templates/layout.html b/doc-source/_templates/layout.html
@@ -1,4 +1,4 @@
-<!--- This file is managed by `repo_helper`. Don't edit it directly --->
+<!--- This file is managed by 'repo_helper'. Don't edit it directly. --->
 {% extends "!layout.html" %}
 {% block extrahead %}
 	<link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
diff --git a/doc-source/conf.py b/doc-source/conf.py
diff --git a/doc-source/contributing.rst b/doc-source/contributing.rst
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tests/requirements.txt b/tests/requirements.txt
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-# This file is managed by `repo_helper`. Don't edit it directly
	`1`	`+# This file is managed by 'repo_helper'. Don't edit it directly.`
`2`	`2`	`---`
`3`	`3`
`4`	`4`	`version: 1`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# This file is managed by 'repo_helper'. Don't edit it directly.`
`1`	`2`	`---`
`2`	`3`	`name: "Docs Check"`
`3`	`4`	`on:`