#5 add pre-commit hooks

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files

README.md

@@ -12,4 +12,16 @@ The project implements all of the core components (accession, dissemination) and
 
 Each source and disseination target should be developed in a separate accelerator-source-xxx or accelerator-dissemination-xxx repository
 
-
+
+## Developer Notes
+
+This project uses pre-commit hooks to validate code, run tests, and accomplish other tasks.
+
+Loading the requirements.txt into your dev environment will install pre-commit, then you can set up the pre-commit
+hooks by running:
+
+```
+pre-commit install
+```
+
+This should be the first thing you do when cloning this project

accelerator_core/schema/README.md

@@ -3,11 +3,10 @@
 
 ## Description
 
-This accel.json file, and the accompanying JSON schema, represent the core data model for Accelerator. 
+This accel.json file, and the accompanying JSON schema, represent the core data model for Accelerator.
 
 
 ## Development process
 
 The initial accel.json file is derived from the Excel model of the 1.5 CHORDS model
 found here: https://nih.sharepoint.com/:f:/r/sites/NIH-DataAcceleratorProgram/Shared%20Documents/General/Design/term%20mappings?csf=1&web=1&e=1JTZT1
-

accelerator_core/schema/accel.json

@@ -111,4 +111,4 @@
       }
     ]
   }
-}
+}

accelerator_core/utils/config.py

@@ -18,4 +18,4 @@ def determine_resource_path(resource_package, resource_name) -> Path:
 
     with importlib.resources.path(resource_package, resource_name) as fspath:
         logger.debug(f"resource path:{fspath}")
-        return fspath
+        return fspath

requirements.txt

@@ -1,3 +1,3 @@
 setuptools~=65.6.3
 jsonschema~=4.23.0
-pre-commit~=4.1.0
+pre-commit~=4.1.0

setup.py

@@ -17,4 +17,4 @@
         "Operating System :: OS Independent",
     ],
     python_requires=">=3.9",
-)
+)