Merge pull request #112 from Exabyte-io/feature/SOF-7747

Author: VsevolodX

.github/workflows/cicd.yml

@@ -1,39 +1,69 @@
-name: Continuous testing and publication to NPM from 'main'
+name: Continuous Testing and Publication
 
-on: # yamllint disable-line rule:truthy
-  workflow_dispatch:
-  push:
+on: [ push ]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
   cancel-in-progress: true
 
-
 jobs:
+  run-py-linter:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: [ 3.10.13 ]
 
-  run-linter:
-    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout this repository
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Checkout actions repository
+        uses: actions/checkout@v4
+        with:
+          repository: Exabyte-io/actions
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          path: actions
+
+      - name: Run ruff linter
+        uses: ./actions/py/lint
+        with:
+          python-version: ${{ matrix.python-version }}
+
+  run-py-tests:
+    needs: run-py-linter
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version:
+          - 3.10.x
+          - 3.11.x
+          - 3.12.x
+          - 3.13.x
 
     steps:
       - name: Checkout this repository
         uses: actions/checkout@v4
+        with:
+          lfs: true
 
       - name: Checkout actions repository
         uses: actions/checkout@v4
         with:
           repository: Exabyte-io/actions
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           path: actions
-# TODO: re-add when we have Python code to lint
-#      - name: Run Py linter
-#        uses: ./actions/py/lint
-#        with:
-#          python-version: 3.10.13
-#          targets: ./assets
+
+      - name: Run python unit tests
+        uses: ./actions/py/pytest
+        with:
+          python-version: ${{ matrix.python-version }}
+          unit-test-directory: tests/py
+          bot-ssh-key: ${{ secrets.BOT_GITHUB_KEY }}
 
   run-js-tests:
     runs-on: ubuntu-latest
-    if: github.repository != 'Exabyte-io/template-definitions'
     strategy:
       matrix:
         node-version:
@@ -43,6 +73,8 @@ jobs:
     steps:
       - name: Checkout this repository
         uses: actions/checkout@v4
+        with:
+          lfs: true
 
       - name: Checkout actions repository
         uses: actions/checkout@v4
@@ -51,15 +83,24 @@ jobs:
           token: ${{ secrets.BOT_GITHUB_TOKEN }}
           path: actions
 
+      - name: Run JS validate
+        uses: ./actions/js/validate
+        with:
+          node-version: '20.x'
+          skip-eslint: 'true'
+
       - name: Run JS tests
         uses: ./actions/js/test
         with:
           node-version: ${{ matrix.node-version }}
 
   publish-js-package:
-    needs: [run-js-tests]
+    needs:
+      - run-js-tests
+      - run-py-tests
+      - run-py-linter
     runs-on: ubuntu-latest
-    if: (github.repository != 'Exabyte-io/template-definitions') && (github.ref_name == 'main' || github.ref_name == 'dev')
+    if: github.ref_name == 'main'
 
     steps:
       - name: Checkout this repository
@@ -75,5 +116,38 @@ jobs:
       - name: Publish JS release
         uses: ./actions/js/publish
         with:
+          node-version: 20.x
           npm-token: ${{ secrets.NPM_TOKEN }}
           github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          verify-tests: 'false'
+
+  publish-py-package:
+    needs:
+      - run-js-tests
+      - run-py-tests
+      - run-py-linter
+      # Wait for JS publish step to publish the new tag
+      - publish-js-package
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'main'
+
+    steps:
+      - name: Checkout this repository
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Checkout actions repository
+        uses: actions/checkout@v4
+        with:
+          repository: Exabyte-io/actions
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          path: actions
+
+      - name: Publish python release
+        uses: ./actions/py/publish
+        with:
+          python-version: 3.10.13
+          github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          pypi-api-token: ${{ secrets.PYPI_API_TOKEN }}
+          publish-tag: 'false'

.gitignore

@@ -6,3 +6,20 @@ node_modules/
 .idea/
 src/workflows/workflows.js
 .DS_Store
+
+# Python
+.venv*/
+*.pyc
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+*.egg-info/
+.eggs/
+.pytest_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.tox/
+.ruff_cache/

package.json

@@ -3,23 +3,23 @@
     "version": "0.0.0",
     "description": "WOrkflow DEfinitions",
     "scripts": {
-        "test": "nyc --reporter=text mocha --recursive --bail --require @babel/register/lib --require tests/setup.js tests",
-        "lint": "eslint src tests && prettier --write src tests",
-        "lint:fix": "eslint --fix --cache src tests && prettier --write src tests",
-        "transpile": "babel --out-dir dist src",
+        "test": "nyc --reporter=text mocha --recursive --bail --require @babel/register/lib --require tests/js/setup.js tests/js",
+        "lint": "eslint src/js tests/js && prettier --write src/js tests/js",
+        "lint:fix": "eslint --fix --cache src/js tests/js && prettier --write src/js tests/js",
+        "transpile": "babel --out-dir dist/js src/js",
         "postinstall": "npm run transpile",
-        "prettier": "prettier --check src tests",
+        "prettier": "prettier --check src/js tests/js",
         "prepare": "husky install || exit 0"
     },
     "repository": {
         "type": "git",
         "url": "https://github.com/Exabyte-io/wode.git"
     },
-    "main": "dist/index.js",
+    "main": "dist/js/index.js",
     "files": [
         "/assets",
         "/dist",
-        "/src",
+        "/src/js",
         ".babelrc",
         "build_workflows.js"
     ],
@@ -88,7 +88,7 @@
         "node": ">=20.0.0"
     },
     "lint-staged": {
-        "*.js": "eslint --cache --fix",
-        "*.{js,css}": "prettier --write"
+        "src/js/**/*.js": ["eslint --cache --fix", "prettier --write"],
+        "tests/js/**/*.js": ["eslint --cache --fix", "prettier --write"]
     }
 }

pyproject.toml

@@ -0,0 +1,91 @@
+[project]
+name = "mat3ra-wode"
+dynamic = ["version"]
+description = "WOrkflow DEfinitions"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE.md"}
+authors = [
+    { name = "Exabyte Inc.", email = "[email protected]" }
+]
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Development Status :: 3 - Alpha",
+    "Topic :: Software Development",
+]
+dependencies = [
+    "numpy",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "black",
+    "ruff",
+    "isort",
+    "mypy",
+    "pip-tools",
+]
+tests = [
+    "coverage[toml]>=5.3",
+    "pytest",
+    "pytest-cov",
+]
+all = [
+    "mat3ra-wode[tests]",
+    "mat3ra-wode[dev]",
+]
+
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools-scm[toml]>=3.4"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+git_describe_command = "git describe --tags --long"
+
+[tool.setuptools.packages.find]
+where = ["src/py"]
+
+[tool.black]
+line-length = 120
+target-version = ['py310']
+extend-exclude = '''
+(
+    tests\/fixtures*,
+    examples\/.*\/.*\.py
+  | other\/.*\/.*\.(py|ipynb)
+)
+'''
+
+[tool.ruff]
+extend-exclude = [
+    "src/js",
+    "tests/fixtures"
+]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+include_trailing_comma = true
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src/py",
+]
+testpaths = [
+    "tests/py"
+]
+