ARROW-60 (cont) Add pre-commit config (#53)

Author: blink1073

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Initial pre-commit reformat
+981492824d1202580729c7084571425457e5e13c

.github/workflows/test-python.yml

@@ -8,12 +8,24 @@ concurrency:
   group: tests-${{ github.ref }}
   cancel-in-progress: true
 
-defaults:  
-  run:  
+defaults:
+  run:
     working-directory: ./bindings/python
     shell: bash
 
 jobs:
+
+  pre-commit:
+    name: pre-commit
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: --all-files --hook-stage=manual
+
   build:
     # supercharge/mongodb-github-action requires containers so we don't test other platforms
     runs-on: ${{ matrix.os }}

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v3.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-case-conflict
+  - id: check-toml
+  - id: check-yaml
+  - id: debug-statements
+  - id: end-of-file-fixer
+    exclude: WHEEL
+    exclude_types: [json]
+  - id: forbid-new-submodules
+  - id: trailing-whitespace
+    exclude: .patch
+    exclude_types: [json]
+
+- repo: https://github.com/psf/black
+  rev: 22.1.0
+  hooks:
+  - id: black
+    files: \.py$
+    args: [--line-length=100]
+
+- repo: https://github.com/PyCQA/isort
+  rev: 5.7.0
+  hooks:
+  - id: isort
+    files: \.py$
+    args: [--profile=black]
+
+# We use the Python version instead of the original version which seems to require Docker
+# https://github.com/koalaman/shellcheck-precommit
+- repo: https://github.com/shellcheck-py/shellcheck-py
+  rev: v0.8.0.1
+  hooks:
+    - id: shellcheck
+      name: shellcheck
+      args: ["--severity=warning"]
+
+- repo: https://github.com/sirosen/check-jsonschema
+  rev: 0.10.2
+  hooks:
+    - id: check-jsonschema
+      name: "Check GitHub Workflows"
+      files: ^\.github/workflows/
+      types: [yaml]
+      args: ["--schemafile", "https://json.schemastore.org/github-workflow"]

bindings/python/.gitignore

@@ -40,4 +40,4 @@ docs/_build/
 
 # libbson files
 libbson
-mongo-c-driver-*
+mongo-c-driver-*

bindings/python/README.rst

@@ -67,4 +67,4 @@ Documentation
 Full documentation is available on `Read the Docs`_.
 
 
-.. _Read the Docs: https://mongo-arrow.readthedocs.io/en/latest
+.. _Read the Docs: https://mongo-arrow.readthedocs.io/en/latest

bindings/python/docs/source/changelog.rst

@@ -36,4 +36,3 @@ Changes in Version 0.1.0
   - 32-bit integer
   - 64-bit integer
   - Timestamp
-

bindings/python/docs/source/developer/installation.rst

@@ -65,3 +65,20 @@ To run the test suite, you will need a MongoDB instance running on
 ``localhost`` using port ``27017``. To run the entire test suite, do::
 
   (pymongoarrow) $ python -m unittest discover test
+
+Running Linters
+---------------
+
+PyMongoArrow uses `pre-commit <https://pypi.org/project/pre-commit/>`_
+for managing linting of the codebase.
+``pre-commit`` performs various checks on all files in PyMongoArrow and uses tools
+that help follow a consistent code style within the codebase.
+
+To set up ``pre-commit`` locally, run::
+
+    pip install pre-commit
+    pre-commit install
+
+To run ``pre-commit`` manually, run::
+
+    pre-commit run --all-files

bindings/python/docs/source/quickstart.rst

@@ -117,4 +117,3 @@ of formats including CSV, and HDF. For example, to write the data frame
 referenced by the variable ``df`` to a CSV file ``out.csv``, run::
 
   df.to_csv('out.csv', index=False)
-

bindings/python/docs/source/supported_types.rst

@@ -43,4 +43,3 @@ respectively, and '_id' that is an `ObjectId`, your schema can be defined as::
 
 Unsupported data types in a schema cause a ``ValueError`` identifying the
 field and its data type.
-