Merge pull request #401 from l0b0/introduce-pre-commit

Introduce pre-commit

Author: Jon Duckworth

.github/pull_request_template.md

@@ -6,7 +6,7 @@
 
 **PR Checklist:**
 
-- [ ] Code is formatted (run `scripts/format`)
+- [ ] Code is formatted (run `pre-commit run --all-files`)
 - [ ] Tests pass (run `scripts/test`)
 - [ ] This PR maintains or improves overall codebase code coverage.
 - [ ] Changes are added to the [CHANGELOG](https://github.com/stac-utils/pystac/blob/develop/CHANGELOG.md). See [the docs](https://pystac.readthedocs.io/en/latest/contributing.html#changelog) for information about adding to the changelog.

.github/workflows/continuous-integration.yml

@@ -58,6 +58,7 @@ jobs:
 
       - name: Install dependencies
         run: |
+          pip install --upgrade pip
           pip install -r requirements-test.txt
           pip install -e ".[validation]"
       
@@ -103,10 +104,11 @@ jobs:
 
       - name: Install dependencies
         run: |
+          pip install --upgrade pip
           pip install -r requirements-test.txt
 
       - name: Execute linters & type checkers
-        run: ./scripts/lint
+        run: pre-commit run --all-files
 
   vanilla:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# Configuration file for pre-commit (https://pre-commit.com/).
+# Please run `pre-commit run --all-files` when adding or changing entries.
+
+repos:
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        entry: black
+        language: system
+        stages: [commit]
+        types: [python]
+
+      - id: codespell
+        name: codespell
+        entry: codespell
+        args: [--ignore-words=.codespellignore]
+        language: system
+        stages: [commit]
+        types_or: [jupyter, markdown, python, shell]
+
+      - id: doc8
+        name: doc8
+        entry: doc8
+        language: system
+        files: \.rst$
+        require_serial: true
+
+      - id: flake8
+        name: flake8
+        entry: flake8
+        language: system
+        stages: [commit]
+        types: [python]
+
+      - id: mypy
+        name: mypy
+        entry: mypy
+        args: [--no-incremental]
+        language: system
+        stages: [commit]
+        types: [python]
+        require_serial: true

README.md

@@ -55,79 +55,7 @@ See the [documentation page](https://pystac.readthedocs.io/en/latest/) for the l
 
 ## Developing
 
-To ensure development libraries are installed, install everything in `requirements-dev.txt`:
-
-```
-> pip install -r requirements-dev.txt
-```
-
-### Unit Tests
-
-Unit tests are in the `tests` folder. To run unit tests, use `unittest`:
-
-```
-> python -m unittest discover tests
-```
-
-To run linters, code formatters, and test suites all together, use `test`:
-
-```
-> ./scripts/test
-```
-
-### Code quality checks
-
-PySTAC uses [flake8](http://flake8.pycqa.org/en/latest/) and [yapf](https://github.com/google/yapf) for code formatting and style checks.
-
-To run the flake8 style checks:
-
-```
-> flake8 pystac tests
-```
-
-To format code:
-
-```
-> yapf -ipr pystac tests
-```
-
-Note that you may have to use `yapf3` explicitly depending on your environment.
-
-To check for spelling mistakes in modified files:
-
-```
-> git diff --name-only | xargs codespell -I .codespellignore -f
-```
-
-You can also run the `./scripts/test` script to check for linting, spelling, and run unit tests.
-
-### Continuous Integration
-
-CI will run the `scripts/test` script to check for code quality. If you have a Pull Request that fails CI, make sure to fix any linting, spelling or test issues reported by `scripts/test`.
-
-### Documentation
-
-To build and develop the documentation locally, make sure sphinx is available (which is installed with `requirements-dev.txt`), and use the Makefile in the docs folder:
-
-```
-> cd docs
-> make html
-> make livehtml
-```
-
-> Note: You will see some warnings along the lines of
-> ```
-> WARNING: duplicate object description of pystac.Collection.id,
-> other instance in api, use :noindex: for one of them
-> ```
-> for some of the
-> classes. This is expected due to [sphinx-doc/sphinx#8664](https://github.com/sphinx-doc/sphinx/issues/8664).
-
-Use 'make' without arguments to see a list of available commands.
-
-__Note__: `nbsphinx` requires that a local `pystac` is installed; use `pip install -e .`.
-
-
+See [contributing docs](docs/contributing.rst)
 
 ## Running the quickstart and tutorials
 

docs/conf.py

@@ -17,22 +17,21 @@
 import subprocess
 from typing import Any, Dict
 
-sys.path.insert(0, os.path.abspath('.'))
-sys.path.insert(0, os.path.abspath('../'))
-from pystac.version import __version__, STACVersion
+sys.path.insert(0, os.path.abspath("."))
+sys.path.insert(0, os.path.abspath("../"))
+from pystac.version import __version__, STACVersion  # noqa:E402
 
-git_branch = subprocess.check_output(['git',
-                                      'rev-parse',
-                                      '--abbrev-ref',
-                                      'HEAD']) \
-                       .decode("utf-8") \
-                       .strip()
+git_branch = (
+    subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
+    .decode("utf-8")
+    .strip()
+)
 
 # -- Project information -----------------------------------------------------
 
-project = 'pystac'
-copyright = '2019, Azavea'
-author = 'stac-utils'
+project = "pystac"
+copyright = "2019, Azavea"
+author = "stac-utils"
 
 # The short X.Y version
 version = __version__
@@ -50,35 +49,41 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.extlinks',
-    'sphinxcontrib.fulltoc',
-    'nbsphinx'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.extlinks",
+    "sphinxcontrib.fulltoc",
+    "nbsphinx",
 ]
 
 extlinks = {
-    'tutorial': ('https://github.com/stac-utils/pystac/'
-                  'tree/{}/docs/tutorials/%s'.format(git_branch), 'tutorial'),
-    'stac-spec': ('https://github.com/radiantearth/stac-spec/tree/'
-                  'v{}/%s'.format(STACVersion.DEFAULT_STAC_VERSION), 'path'),
-    'stac-ext': ('https://github.com/stac-extensions/%s', '%s extension')
+    "tutorial": (
+        "https://github.com/stac-utils/pystac/"
+        "tree/{}/docs/tutorials/%s".format(git_branch),
+        "tutorial",
+    ),
+    "stac-spec": (
+        "https://github.com/radiantearth/stac-spec/tree/"
+        "v{}/%s".format(STACVersion.DEFAULT_STAC_VERSION),
+        "path",
+    ),
+    "stac-ext": ("https://github.com/stac-extensions/%s", "%s extension"),
 }
 
 # 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.
@@ -90,7 +95,7 @@
 # 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', '**.ipynb_checkpoints']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -101,7 +106,7 @@
 # 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"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -119,7 +124,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.
@@ -135,7 +140,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pystacdoc'
+htmlhelp_basename = "pystacdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -144,15 +149,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',
@@ -162,19 +164,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'pystac.tex', 'pystac Documentation',
-     'stac-utils', 'manual'),
+    (master_doc, "pystac.tex", "pystac Documentation", "stac-utils", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'pystac', 'pystac Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "pystac", "pystac Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -183,9 +181,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'pystac', 'pystac Documentation',
-     author, 'pystac', 'Python library for SpatioTemporal Asset Catalogs (STAC).',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "pystac",
+        "pystac Documentation",
+        author,
+        "pystac",
+        "Python library for SpatioTemporal Asset Catalogs (STAC).",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -204,11 +208,11 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
+    "python": ("https://docs.python.org/3", None),
 }