set up pre-commit

Author: blink1073

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial pre-commit reformat
+42fe3bb4188a1fbd1810674776e7855cd529b8fc

.github/workflows/test.yml

@@ -5,9 +5,8 @@ name: Python package
 
 on:
   push:
-    branches: '*'
   pull_request:
-    branches: [ master ]
+    branches: [ "master" ]
 
 jobs:
   build:
@@ -49,3 +48,7 @@ jobs:
     - name: Test with pytest
       run: |
         pytest -vv jupyter_core --timeout 60 --cov jupyter_core --cov-report term-missing:skip-covered
+    - name: Check manifest
+      run: |
+        pip install check-manifest
+        check-manifest -v

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+ci:
+  skip: [check-jsonschema]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: debug-statements
+  #     - id: end-of-file-fixer
+  #     - id: check-case-conflict
+  #     - id: check-executables-have-shebangs
+  #     - id: requirements-txt-fixer
+  #     - id: check-added-large-files
+  #     - id: check-case-conflict
+  #     - id: check-toml
+  #     - id: check-yaml
+  #     - id: forbid-new-submodules
+  #     - id: check-builtin-literals
+  #     - id: trailing-whitespace
+
+  # - repo: https://github.com/psf/black
+  #   rev: 22.3.0
+  #   hooks:
+  #     - id: black
+  #       args: ["--line-length", "100"]
+
+  # - repo: https://github.com/PyCQA/isort
+  #   rev: 5.10.1
+  #   hooks:
+  #     - id: isort
+  #       files: \.py$
+  #       args: [--profile=black]
+
+  # - repo: https://github.com/pre-commit/mirrors-prettier
+  #   rev: v2.6.2
+  #   hooks:
+  #     - id: prettier
+
+  # - repo: https://github.com/asottile/pyupgrade
+  #   rev: v2.31.1
+  #   hooks:
+  #     - id: pyupgrade
+  #       args: [--py37-plus]
+
+  - repo: https://github.com/PyCQA/doc8
+    rev: 0.11.1
+    hooks:
+      - id: doc8
+        args: [--max-line-length=200]
+
+  # - repo: https://github.com/pycqa/flake8
+  #   rev: 4.0.1
+  #   hooks:
+  #     - id: flake8
+  #       additional_dependencies:
+  #         [
+  #           "flake8-bugbear==20.1.4",
+  #           "flake8-logging-format==0.6.0",
+  #           "flake8-implicit-str-concat==0.2.0",
+  #         ]
+
+  # - repo: https://github.com/pre-commit/mirrors-eslint
+  #   rev: v8.12.0
+  #   hooks:
+  #     - id: eslint
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.14.2
+    hooks:
+      - id: check-jsonschema
+        name: "Check GitHub Workflows"
+        files: ^\.github/workflows/
+        types: [yaml]
+        args: ["--schemafile", "https://json.schemastore.org/github-workflow"]

MANIFEST.in

@@ -3,6 +3,10 @@ include CONTRIBUTING.md
 include README.md
 include dev-requirements.txt
 
+exclude .pre-commit-config.yaml
+exclude .git-blame-ignore-revs
+exclude readthedocs.yml
+
 # Documentation
 graft docs
 graft examples
@@ -11,7 +15,8 @@ graft examples
 graft jupyter_core/tests/dotipython
 graft jupyter_core/tests/dotipython_empty
 
-# docs subdirs we want to skip
+# dirs we want to skip
+prune scripts
 prune docs/_build
 
 # Patterns to exclude from any directory

README.md

@@ -23,6 +23,38 @@ and download the dependencies of code and test suite by executing:
 
 The last command runs the test suite to verify the setup. During development, you can pass filenames to `py.test`, and it will execute only those tests.
 
+
+## Code Styling
+`jupyter_core` has adopted automatic code formatting so you shouldn't
+need to worry too much about your code style.
+As long as your code is valid,
+the pre-commit hook should take care of how it should look.
+`pre-commit` and its associated hooks will automatically be installed when
+you run `pip install -e ".[test]"`
+
+To install `pre-commit` manually, run the following:
+
+```bash
+    pip install pre-commit
+    pre-commit install
+```
+
+You can invoke the pre-commit hook by hand at any time with:
+
+```bash
+    pre-commit run
+```
+
+which should run any autoformatting on your code
+and tell you about any errors it couldn't fix automatically.
+You may also install [black integration](https://github.com/psf/black#editor-integration)
+into your text editor to format code automatically.
+
+If you have already committed files before setting up the pre-commit
+hook with `pre-commit install`, you can fix everything up using
+`pre-commit run --all-files`. You need to make the fixing commit
+yourself after that.
+
 ## Documentation
 
 The documentation of Jupyter Core is generated from the files in `docs/` using Sphinx. Instructions for setting up Sphinx with a selection of optional modules are in the [Documentation Guide](http://jupyter.readthedocs.io/en/latest/contrib_docs/index.html). You'll also need the `make` command.

dev-requirements.txt

@@ -2,3 +2,4 @@ ipykernel
 pytest
 pytest-cov
 pytest-timeout
+pre-commit

docs/changelog.rst

@@ -33,7 +33,11 @@ See the `jupyter_core
 4.9 <https://github.com/jupyter/jupyter_core/milestone/21?closed=1>`__
 milestone on GitHub for the full list of pull requests and issues closed.
 
-- Add Python site user base subdirectories to config and data user-level paths if ``site.ENABLE_USER_SITE`` is True. One way to disable these directory additions is to set the ``PYTHONNOUSERSITE`` environment variable. These locations can be customized by setting the ``PYTHONUSERBASE`` environment variable. (:ghpull:`242`)
+- Add Python site user base subdirectories to config and data user-level paths
+  if ``site.ENABLE_USER_SITE`` is True. One way to disable these directory
+  additions is to set the ``PYTHONNOUSERSITE`` environment variable. These
+  locations can be customized by setting the ``PYTHONUSERBASE`` environment
+  variable. (:ghpull:`242`)
 
 
 4.8
@@ -44,7 +48,10 @@ milestone on GitHub for the full list of pull requests and issues closed.
 `on
 GitHub <https://github.com/jupyter/jupyter_core/releases/tag/4.8.2>`__
 
-jupyter_core 4.8.1 was released the same day as 4.8.0 and also included the fix below for the Windows tests. Unfortunately, the 4.8.1 release commit and tag were not pushed to GitHub. We are releasing 4.8.2 so we have a commit and tag in version control.
+jupyter_core 4.8.1 was released the same day as 4.8.0 and also included the fix
+below for the Windows tests. Unfortunately, the 4.8.1 release commit and tag
+were not pushed to GitHub. We are releasing 4.8.2 so we have a commit and tag
+in version control.
 
 - Fix windows test regression (:ghpull:`240`)
 
@@ -89,7 +96,13 @@ See the `jupyter_core
 4.7 <https://github.com/jupyter/jupyter_core/milestone/19?closed=1>`__
 milestone on GitHub for the full list of pull requests and issues closed.
 
-- Add a new ``JUPYTER_PREFER_ENV_PATH`` variable, which can be set to switch the order of the environment-level path and the user-level path in the Jupyter path hierarchy (e.g., ``jupyter --paths``). It is considered set if it is a value that is not one of 'no', 'n', 'off', 'false', '0', or '0.0' (case insensitive). If you are running Jupyter in multiple virtual environments as the same user, you will likely want to set this environment variable.
+- Add a new ``JUPYTER_PREFER_ENV_PATH`` variable, which can be set to switch
+  the order of the environment-level path and the user-level path in the
+  Jupyter path hierarchy (e.g., ``jupyter --paths``). It is considered set if
+  it is a value that is not one of 'no', 'n', 'off', 'false', '0', or '0.0'
+  (case insensitive). If you are running Jupyter in multiple virtual
+  environments as the same user, you will likely want to set this environment
+  variable.
 - Drop Python 2.x and 3.5 support, as they have reached end of life.
 - Add Python 3.9 builds to testing, and expand testing to cover Windows, macOS, and Linux platforms.
 - ``jupyter --paths --debug`` now explains the environment variables that affect the current path list.