Updated files with 'repo_helper'.

domdfcoding · domdfcoding · commit 0fc2bdaa2886 · 2020-07-20T17:17:20.000Z
diff --git a/.ci/travis_deploy_conda.sh b/.ci/travis_deploy_conda.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 
 set -e -x
 
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,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.
 __pycache__/
 *.py[cod]
 *$py.class
diff --git a/.isort.cfg b/.isort.cfg
@@ -27,3 +27,5 @@ known_third_party =
     requests
     typing_extensions
 known_first_party = domdf_python_tools
+float_to_top = True
+remove_redundant_aliases = True
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -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.
 ---
 
 repos:
@@ -31,12 +31,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: [exclude *.pyi]
+      args: ["--in-place", "--exclude *.pyi"]
 
  - 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
+==============
+
+``domdf_python_tools`` 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 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
+------------------------------
+
+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 domdf_python_tools/ *.pyi
+recursive-include domdf_python_tools *.pyi
 include domdf_python_tools/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/_static/style.css b/doc-source/_static/style.css
@@ -1,5 +1,12 @@
-/* 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;}
+/* Body width */
+.wy-nav-content {max-width: 1200px !important;}
 
+/* Spacing between list items */
 li p:last-child { margin-bottom: 12px !important;}
+
+/* Smooth scrolling between sections */
+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
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-# This file is managed by `repo_helper`. Don't edit it directly
+# This file is managed by 'repo_helper'. Don't edit it directly.
 
 # stdlib
 import os
@@ -49,10 +49,12 @@
 		"sphinx.ext.autosummary",
 		"autodocsumm",
 		"sphinx_copybutton",
+		# "sphinx_gitstamp",
 		]
 
 sphinxemoji_style = 'twemoji'
 todo_include_todos = bool(os.environ.get("SHOW_TODOS", False))
+gitstamp_fmt = "%d %b %Y"
 
 templates_path = ['_templates']
 html_static_path = ['_static']
diff --git a/doc-source/contributing.rst b/doc-source/contributing.rst
@@ -0,0 +1,72 @@
+.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
+
+==============
+Contributing
+==============
+
+``domdf_python_tools`` 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:
+
+.. prompt:: 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 via ``pre-commit``:
+
+.. prompt:: bash
+
+	pre-commit run yapf -a
+	pre-commit run isort -a
+
+
+The complete autoformatting suite can be run with ``pre-commit``:
+
+.. prompt:: 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:
+
+.. prompt:: bash
+
+	tox -e py36
+
+
+To run tests for all Python versions, simply run:
+
+.. prompt:: bash
+
+	tox
+
+
+Type Annotations
+-------------------
+
+Type annotations are checked using ``mypy``. Run ``mypy`` using ``tox``:
+
+.. prompt:: bash
+
+	tox -e mypy
+
+
+
+Build documentation locally
+------------------------------
+
+Documentation is powered by Sphinx. A local copy of the documentation can be built with ``tox``:
+
+.. prompt:: bash
+
+	tox -e docs
diff --git a/make_conda_recipe.py b/make_conda_recipe.py
@@ -1,6 +1,6 @@
 #!/usr/bin/python3
 
-# This file is managed by `repo_helper`. Don't edit it directly
+# {{ managed_message }}
 
 # stdlib
 import platform
diff --git a/setup.cfg b/setup.cfg
@@ -1,3 +1,5 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+
 [metadata]
 name = domdf_python_tools
 description = Helpful functions for Python 🐍 🛠️
diff --git a/setup.py b/setup.py
@@ -1,14 +1,13 @@
 #!/usr/bin/env python
-# This file is managed by `repo_helper`. Don't edit it directly
-"""Setup script"""
+# This file is managed by 'repo_helper'. Don't edit it directly.
 
 # stdlib
 import sys
 
 # 3rd party
 from setuptools import setup
 
-sys.path.append(".")
+sys.path.append('.')
 
 # this package
 from __pkginfo__ import *  # pylint: disable=wildcard-import
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:`