Merge fb266f2 into release

dnv-opensource · Jan 8, 2024 · 4f689a6 · 4f689a6
2 parents 7d4fcb2 + fb266f2
commit 4f689a6
Show file tree

Hide file tree

Showing 26 changed files with 488 additions and 191 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
diff --git a/.github/workflows/_build_and_publish_documentation.yml b/.github/workflows/_build_and_publish_documentation.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout active branch
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
           lfs: true

diff --git a/.github/workflows/_build_package.yml b/.github/workflows/_build_package.yml
@@ -7,7 +7,7 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 1
           lfs: true
@@ -37,7 +37,7 @@ jobs:
   #     matrix:
   #       platform: [ubuntu-latest, macos-latest, windows-latest]
   #   steps:
-  #     - uses: actions/checkout@v3
+  #     - uses: actions/checkout@v4
   #       with:
   #         fetch-depth: 1
   #         lfs: true
@@ -46,7 +46,7 @@ jobs:
   #         python-version: '3.11'
   #         cache: 'pip' # cache pip dependencies
   #     - name: Install cibuildwheel
-  #       run: python -m pip install cibuildwheel==2.3.1
+  #       run: python -m pip install cibuildwheel==2.16
   #     - name: Build wheels
   #       run: python -m cibuildwheel --output-dir wheels
   #     - uses: actions/upload-artifact@v3

diff --git a/.github/workflows/_code_quality.yml b/.github/workflows/_code_quality.yml
@@ -13,7 +13,7 @@ jobs:
           options: '--check --diff'
           src: '.'
           jupyter: true
-          version: '>=23.9'
+          version: '==23.12'
 
   ruff:
     runs-on: ubuntu-latest
@@ -27,7 +27,7 @@ jobs:
       - name: Install dependencies
         run: pip install -r requirements.txt
       - name: Install ruff
-        run: pip install ruff>=0.0.290
+        run: pip install ruff==0.1.8
       - name: Run ruff
         run: ruff .
 
@@ -45,6 +45,6 @@ jobs:
           pip install -r requirements.txt
           pip install pytest
       - name: Install pyright
-        run: pip install pyright>=1.1.325
+        run: pip install pyright==1.1.338
       - name: Run pyright
         run: pyright .
diff --git a/.github/workflows/_merge_into_release.yml b/.github/workflows/_merge_into_release.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     environment: release
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           # Fetch the whole history to prevent unrelated history errors
           fetch-depth: 0

diff --git a/.github/workflows/_test.yml b/.github/workflows/_test.yml
@@ -20,6 +20,8 @@ jobs:
             toxenv: 'py310'
           - version: '3.11'
             toxenv: 'py311'
+          - version: '3.12'
+            toxenv: 'py312'
     steps:
       - uses: actions/checkout@v4
       - name: Install Python ${{ matrix.python.version }}

diff --git a/.github/workflows/_test_future.yml b/.github/workflows/_test_future.yml
@@ -16,8 +16,8 @@ jobs:
           - runner: windows-latest
             toxenv: windows
         python:
-          - version: '3.12.0rc3'
-            toxenv: 'py312'
+          - version: '3.13.0a2'
+            toxenv: 'py313'
     steps:
       - uses: actions/checkout@v4
       - name: Install Python ${{ matrix.python.version }}

diff --git a/.gitignore b/.gitignore
@@ -3,18 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-#vi & emacs
-*~
-'#'*
-
-#packaging
-*.whl
-*.tar.gz
-
-
-#doxygen
-html/
-
 # C extensions
 *.so
 
@@ -140,10 +128,17 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# PyCharm
+.idea
+
+# modules
+modules.txt
+
 # VS Code Settings
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
 !.vscode/*.code-snippets
+
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -10,6 +10,7 @@
         "charliermarsh.ruff",
         "sourcery.sourcery",
         "njpwerner.autodocstring",
+        "editorconfig.editorconfig",
     ],
     // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
     "unwantedRecommendations": []

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -5,33 +5,47 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Debug Unit Test",
+            "name": "Python: Debug Tests",
             "type": "python",
-            "request": "test",
+            "request": "launch",
+            "program": "${file}",
+            "purpose": [
+                "debug-test"
+            ],
+            "console": "integratedTerminal",
+            "env": {
+                "PYTEST_ADDOPTS": "--no-cov"
+            },
+            "autoReload": {
+                "enable": true
+            },
             "justMyCode": false,
         },
         {
-            "name": "Python: Current File",
+            "name": "Python: Current File, cwd = file dir, envFile",
             "type": "python",
             "request": "launch",
-            "cwd": "${fileDirname}",
+            "cwd": "${fileDirname}", // working dir = dir where current file is
             "program": "${file}",
             "console": "integratedTerminal",
-            "justMyCode": true,
             "autoReload": {
                 "enable": true
-            }
+            },
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/.env" // specify where .env file is
         },
         {
-            "name": "Python: Current File, cwd = workspace root folder",
+            "name": "Python: Current File, cwd = workspace root folder, envFile",
             "type": "python",
             "request": "launch",
-            "cwd": "${workspaceFolder}",
+            "cwd": "${workspaceFolder}", // working dir = workspace (mvx) dir
             "program": "${file}",
             "console": "integratedTerminal",
             "autoReload": {
                 "enable": true
-            }
+            },
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/.env" // specify where .env file is
         },
         {
             "name": "dictParser test_dict",
@@ -46,7 +60,9 @@
             "console": "integratedTerminal",
             "autoReload": {
                 "enable": true
-            }
+            },
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/.env" // specify where .env file is
         },
         {
             "name": "dictParser include\\initialConditions",
@@ -61,13 +77,14 @@
             "console": "integratedTerminal",
             "autoReload": {
                 "enable": true
-            }
+            },
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/.env" // specify where .env file is
         },
         {
             "name": "dictParser test_dict .env",
             "type": "python",
             "request": "launch",
-            "envFile": "${workspaceFolder}\\.env",
             "cwd": "${workspaceFolder}\\tests",
             "program": "${workspaceFolder}\\src\\dictIO\\cli\\dictParser.py",
             "args": [
@@ -77,7 +94,9 @@
             "console": "integratedTerminal",
             "autoReload": {
                 "enable": true
-            }
+            },
+            "justMyCode": false,
+            "envFile": "${workspaceFolder}/.env" // specify where .env file is
         },
     ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,17 +1,19 @@
 {
+    "terminal.integrated.env.windows": {
+        "PYTHONPATH": "${workspaceFolder}/src"
+    },
     "python.terminal.activateEnvInCurrentTerminal": true,
     "python.languageServer": "Pylance",
     "ruff.importStrategy": "fromEnvironment",
-    "python.linting.enabled": false,
-    "python.formatting.provider": "black",
     "editor.formatOnSave": true,
     "[python]": {
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
-            "source.organizeImports": true
+            "source.organizeImports": "explicit"
         },
     },
     "autoDocstring.docstringFormat": "numpy",
+    "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,
     "python.analysis.logLevel": "Warning",
     "python.analysis.completeFunctionParens": false,
@@ -22,4 +24,5 @@
     "python.analysis.inlayHints.variableTypes": false,
     "python.analysis.inlayHints.functionReturnTypes": false,
     "python.analysis.inlayHints.pytestParameters": true,
+    "python.terminal.executeInFileDir": true,
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,21 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 
 * -/-
 
+
+## [0.3.0] - 2024-01-08
+
+### Changed
+
+* Enabled recognition of strings with nested quotes in it (solves [#2](https://github.com/dnv-opensource/dictIO/issues/2))
+* GitHub workflows: Included Python 3.12 release version as standard, and Python 3.13.0a2 as "future" test.
+
+### Dependencies
+
+* updated to black[jupyter]==23.12  (from black[jupyter]==23.11)
+* updated to ruff==0.1.8  (from ruff==0.1.6)
+* updated to pyright==1.1.338  (from pyright==1.1.336)
+
+
 ## [0.2.9] - 2023-09-20
 
 ### Dependencies
@@ -206,7 +221,8 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 * Added support for Python 3.10
 
 <!-- Markdown link & img dfn's -->
-[unreleased]: https://github.com/dnv-opensource/dictIO/compare/v0.2.9...HEAD
+[unreleased]: https://github.com/dnv-opensource/dictIO/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/dnv-opensource/dictIO/compare/v0.2.9...v0.3.0
 [0.2.9]: https://github.com/dnv-opensource/dictIO/compare/v0.2.8...v0.2.9
 [0.2.8]: https://github.com/dnv-opensource/dictIO/compare/v0.2.7...v0.2.8
 [0.2.7]: https://github.com/dnv-opensource/dictIO/compare/v0.2.6...v0.2.7