Merge pull request #112 from spacesys-finch/dev

Merge dev for 1.0 release

.github/workflows/pipeline.yml

@@ -0,0 +1,35 @@
+name: Pipeline
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout repository
+      uses: actions/checkout@master
+
+    - name: Set up Python
+      uses: actions/setup-python@master
+      with:
+        python-version: 3.10.x
+
+    - name: Install dependencies
+      run: |
+        curl -sSL https://install.python-poetry.org | python3 -
+        poetry config virtualenvs.in-project true
+        poetry run pip install --upgrade setuptools==57.5.0
+        poetry install
+
+    - name: Pre-commit
+      run: |
+        poetry run pre-commit run --all-files
+  
+    - name: Pytest
+      run: |
+        poetry run pytest -v

.gitignore

@@ -1,9 +1,13 @@
 .DS_Store
 .env
+.mypy_cache
 .pytest_cache
-.vscode
+.venv
 __pycache__
 logs
 output
 scrap.txt
-tmp
+temp-plot.html
+tmp
+*.ppm
+*.mp4

.pre-commit-config.yaml

@@ -1,23 +1,48 @@
 repos:
 - repo: https://github.com/pycqa/isort
-  rev: "5.10.1"
+  rev: 5.10.1
   hooks:
   - id: isort
 
 - repo: https://github.com/psf/black
-  rev: 21.12b0
+  rev: 22.3.0
   hooks:
   - id: black
-    language_version: python3.9
+
+- repo: https://github.com/PyCQA/autoflake
+  rev: v1.7.7
+  hooks:
+  - id: autoflake
+
+- repo: https://github.com/asottile/pyupgrade
+  rev: v2.32.0
+  hooks:
+  - id: pyupgrade
 
 - repo: https://github.com/myint/docformatter
-  rev: v1.4
+  rev: v1.5.0
+  hooks:
+  - id: docformatter
+    args: [--blank, --in-place, --recursive, --wrap-descriptions=88, --wrap-summaries=80] # does not yet support toml config
+
+# - repo: https://github.com/pre-commit/mirrors-mypy
+#   rev: v0.971
+#   hooks:
+#     - id: mypy
+#       exclude: ^tests/
+
+
+- repo: https://github.com/nbQA-dev/nbQA
+  rev: 1.3.1
   hooks:
-    - id: docformatter
-      args: [--blank, --in-place, --recursive, --wrap-descriptions=70, --wrap-summaries=80]
+  - id: nbqa-isort
+  - id: nbqa-black
+  - id: nbqa-pyupgrade
 
-- repo: https://github.com/pycqa/pylint
-  rev: v2.12.2
+- repo: local # https://github.com/pre-commit/pre-commit/issues/178#issuecomment-557113127
   hooks:
   - id: pylint
-    additional_dependencies: [pytest, numpy, plotly, scipy]
+    name: pylint
+    entry: poetry run pylint
+    language: system
+    types: [python]

.vscode/extensions.json

@@ -0,0 +1,27 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"bierner.markdown-emoji",
+		"eamodio.gitlens",
+		"formulahendry.code-runner",
+		"maptz.regionfolder",
+		"mechatroner.rainbow-csv",
+		"minhthai.vscode-todo-parser",
+		"ms-python.pylint",
+		"ms-python.python", 
+		"ms-python.vscode-pylance", 
+		"ms-toolsai.jupyter",
+		"ms-toolsai.jupyter-renderers",
+		"ms-vscode.live-server",
+		"mutantdino.resourcemonitor",
+		"ryanluker.vscode-coverage-gutters",
+		"zh9528.file-size",
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": [
+
+	]
+}

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Tests",
+            "type": "python",
+            "request": "test",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "env": {"PYTEST_ADDOPTS": "--no-cov"}
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.linting.pylintEnabled": false,
+    "python.linting.enabled": false,
+    "python.linting.prospectorEnabled": false,
+    "python.linting.mypyEnabled": true
+}