Merge pull request #2 from lincc-frameworks/issue/1/tests

Add e2e unit test to parse anticipated output

.copier-answers.yml

@@ -5,11 +5,10 @@ author_email: [email protected]
 author_name: LINCC Frameworks Team
 create_example_module: false
 custom_install: true
-include_docs: true
-include_notebooks: true
+include_docs: false
 mypy_type_checking: none
 package_name: lf_asv_formatter
-preferred_linter: black
+preferred_linter: pylint
 project_license: MIT
 project_name: lf-asv-formatter
 use_gitlfs: none

.github/workflows/linting.yml

@@ -31,6 +31,5 @@ jobs:
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Analyze code with linter
 
-      uses: psf/black@stable
-      with:
-        src: ./src
+      run: |
+        pylint -rn -sn --recursive=y ./src --rcfile=./src/.pylintrc

.pre-commit-config.yaml

@@ -68,43 +68,41 @@ repos:
         files: ^(src|tests)/
 
 
-    # Analyze the code style and report code that doesn't adhere.
-  - repo: https://github.com/psf/black
-    rev: 23.1.0
+    # Analyze the src code style and report code that doesn't adhere.
+  - repo: local
     hooks:
-      - id: black
+      - id: pylint
+        name: pylint (python files in src/)
+        entry: pylint
+        language: system
         types: [python]
         files: ^(src|tests)/
         # It is recommended to specify the latest version of Python
         # supported by your project here, or alternatively use
         # pre-commit's default_language_version, see
         # https://pre-commit.com/#top_level-default_language_version
         language_version: python3.10
-
-
-    # Make sure Sphinx can build the documentation while explicitly omitting 
-    # notebooks from the docs, so users don't have to wait through the execution 
-    # of each notebook or each commit. By default, these will be checked in the 
-    # GitHub workflows.
+        files: ^src/
+        args:
+          [
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+            "--rcfile=src/.pylintrc",
+          ]
+    # Analyze the tests code style and report code that doesn't adhere.
   - repo: local
     hooks:
-      - id: sphinx-build
-        name: Build documentation with Sphinx
-        entry: sphinx-build
+      - id: pylint
+        name: pylint (python files in tests/)
+        entry: pylint
         language: system
-        always_run: true
-        exclude_types: [file, symlink]
+        types: [python]
+        files: ^tests/
         args:
           [
-            "-M", # Run sphinx in make mode, so we can use -D flag later
-                  # Note: -M requires next 3 args to be builder, source, output
-            "html", # Specify builder
-            "./docs", # Source directory of documents
-            "./_readthedocs", # Output directory for rendered documents
-            "-T", # Show full trace back on exception
-            "-E", # Don't use saved env; always read all files
-            "-d", # Flag for cached environment and doctrees
-            "./docs/_build/doctrees", # Directory
-            "-D", # Flag to override settings in conf.py
-            "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+            "--rcfile=tests/.pylintrc",
           ]
+
+

README.md

@@ -1,12 +1,6 @@
-# lf-asv-formatter
+# ASV Formatter
 
 [![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)
 
-This project was automatically generated using the LINCC-Frameworks 
-[python-project-template](https://github.com/lincc-frameworks/python-project-template).
-
-A repository badge was added to show that this project uses the python-project-template, however it's up to
-you whether or not you'd like to display it!
-
-For more information about the project template see the 
-[documentation](https://lincc-ppt.readthedocs.io/en/latest/).
+Simple script to re-format the output of ASV (air-speed-velocity) benchmarking
+outputs for use in github messages.