#6 update directory layout (#8)

Author: kernelsam

.github/workflows/pylint.yaml

@@ -12,25 +12,30 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-      - name: set up Python ${{ matrix.python-version }}
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: install dependencies
+      - name: Install dependencies
         run: |
+          python -m venv ./venv
+          source ./venv/bin/activate
+          echo "PATH=${PATH}" >> "${GITHUB_ENV}"
           python -m pip install --upgrade pip
-          pip install pylint
+          python -m pip install --requirement development-requirements.txt
+          python -m pip install --requirement requirements.txt
 
-      - name: analysing the code with pylint
+      - name: Analysing the code with pylint
         run: |
           # shellcheck disable=SC2046
-          pylint $(git ls-files '*.py')
+          pylint $(git ls-files '*.py' ':!:docs/source/*')
 
   slack-notification:
     needs: [pylint]

.gitignore

@@ -6,3 +6,4 @@
 *.code-workspace
 .history
 
+.mypy_cache

.vscode/cspell.json

@@ -15,32 +15,38 @@
     "HUANGPU",
     "ICLA",
     "Imabari",
+    "isort",
     "Kaiji",
+    "kwargs",
     "MARU",
     "mcorpm",
     "Mipo",
     "mmsi",
     "Moller",
-    "Moller",
     "mypy",
     "Newbuilding",
     "NINGBO",
     "nomino",
     "pylint",
+    "pytest",
     "SANYO",
     "Senzing",
+    "setuptools",
     "shellcheck",
     "stackoverflow",
     "subrecord",
     "Sulzer",
     "tpcmi",
+    "venv",
     "WAIGAOQIAO",
     "Wartsila",
     "WENCHONG",
     "XINLE"
   ],
   "ignorePaths": [
     ".git/**",
-    ".mypy_cache/**"
+    ".mypy_cache/**",
+    "development-requirements.txt",
+    "documentation-requirements.txt"
   ]
 }

development-requirements.txt

@@ -0,0 +1,18 @@
+bandit==1.8.5
+black==25.1.0
+build==1.2.2.post1
+coverage==7.9.2
+cryptography==45.0.4
+flake8==7.2.0
+fpvs==0.3.0
+isort==6.0.1
+mypy==1.16.1
+psutil==7.0.0
+pylint-per-file-ignores==1.4.0
+pylint==3.3.7
+pytest-cov==6.2.1
+pytest-schema==0.1.2
+pytest==8.4.1
+twine==6.1.0
+virtualenv==20.31.2
+wheel==0.46.1

documentation-requirements.txt

@@ -0,0 +1,18 @@
+autodocsumm==0.2.14
+myst_parser==4.0.1
+sphinx
+sphinx-autodoc-typehints==3.1.0
+sphinx-gallery==0.19.0
+sphinx-jinja2-compat==0.3.0
+sphinx-prompt==1.9.0
+sphinx-rtd-theme==3.0.2
+sphinx-tabs==3.4.7
+sphinx-toolbox==4.0.0
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jquery==4.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+sphinxext-remoteliteralinclude==0.6.0

pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+test = ["pytest", "coverage"]
+
+[tool.bandit]
+skips = ["B101"]
+
+[tool.black]
+line-length = 120
+
+[tool.flake8]
+extend-ignore = ["E203", "E704"]
+max-line-length = 120
+
+[tool.isort]
+profile = "black"
+src_paths = ["examples", "src", "tests"]
+
+[tool.pylint]
+ignored-argument-names = "args|kwargs"
+disable = [
+    "consider-using-with",
+    "invalid-name",
+    "line-too-long",
+    "too-many-branches",
+    "too-many-lines",
+    "too-many-statements",
+    "unspecified-encoding",
+]
+good-names = [
+    "mapper-equifax"
+]
+ignore = [
+    "__init__.py",
+    "docs/source/conf.py"
+]
+notes = [
+    "FIXME"
+]