♻️ repo cleanup and doc (#179)

Author: pcrespov

.github/workflows/build-python-client.yml

@@ -18,24 +18,27 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.10.14
+      - name: install uv
+        uses: yezz123/setup-uv@v4
       - name: Setup Python environment
         run: |
           git status
           make devenv
           source .venv/bin/activate
-      - name: Process tag
+      - name: Git tag to VERSION
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
         run: |
           source .venv/bin/activate
           version=$(echo ${{ github.ref }} | grep -oP '(?<=refs/tags/v)\d+\.\d+\.\d+')
           python scripts/is_semantic_version.py "${version}"
-          echo "${version}" > clients/python/client/VERSION
-      - name: Generate client
+          echo "${version}" > clients/python/VERSION
+      - name: Auto-generate python_client and build distributions
         run: |
           source .venv/bin/activate
           cd clients/python
-          make install-dev
-          make dist-ci
+          uv pip install -r requirements/dev.txt
+          make python-client
+          make dist
       - name: Set variables
         id: variables
         run: |
@@ -70,6 +73,8 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+      - name: install uv
+        uses: yezz123/setup-uv@v4
       - name: Pip cache
         uses: actions/cache@v3
         with:
@@ -90,6 +95,7 @@ jobs:
           python -m pip install clients/python/artifacts/dist/${{needs.build.outputs.osparc}} --find-links=clients/python/artifacts/dist
           cd clients/python
           make install-unit-test
+          uv pip list | grep osparc
           pytest -v --ignore=/artifacts/client --ignore=test/e2e
 
   test-latest:
@@ -106,6 +112,8 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+      - name: install uv
+        uses: yezz123/setup-uv@v4
       - name: Pip cache
         uses: actions/cache@v3
         with:
@@ -122,8 +130,8 @@ jobs:
         run: |
           python -m venv .venv
           source .venv/bin/activate
-          python -m pip install pytest
-          python -m pip install clients/python/artifacts/dist/${{needs.build.outputs.osparc}} --find-links=clients/python/artifacts/dist
+          uv pip install pytest
+          uv pip install clients/python/artifacts/dist/${{needs.build.outputs.osparc}} --find-links=clients/python/artifacts/dist
           cd clients/python
           make install-unit-test
           pytest -v --ignore=/artifacts/client --ignore=test/e2e

.gitignore

@@ -78,7 +78,14 @@ tmp*
 
 # auto generated python code
 /clients/python/artifacts/*
-/clients/python/client/build/*
-/clients/python/client/osparc/data/openapi.json
+/clients/python/src/build/*
+/clients/python/src/osparc/data/openapi.json
+/clients/python/VERSION
 /clients/python/test/e2e/pytest.ini
-/clients/python/client/VERSION
+
+
+# key-words in filename to ignore them
+*secret*
+*ignore*
+!.dockerignore
+!.gitignore

.pre-commit-config.yaml

@@ -27,16 +27,13 @@ repos:
         types: ["file"]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.0.282
+    rev: v0.6.2
     hooks:
       - id: ruff
-        args: [ --fix, --exit-non-zero-on-fix ]
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort (python)
-        args: ["--profile", "black"]
+        args:
+          - --fix
+          - --exit-non-zero-on-fix
+      - id: ruff-format
   - repo: https://github.com/psf/black
     rev: 23.7.0
     hooks:

.vscode/launch.template.json

@@ -0,0 +1,34 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "Python: Run Test",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "--ff",
+                "--log-cli-level=INFO",
+                "--pdb",
+                "--setup-show",
+                "-sx",
+                "-vv",
+                "--asyncio-mode=auto",
+                "${file}"
+            ],
+            "cwd": "${workspaceFolder}",
+            "console": "integratedTerminal",
+            "justMyCode": false
+        }
+    ]
+}

.vscode/settings.template.json

@@ -1,4 +1,15 @@
 {
+    "files.associations": {
+        ".*rc": "ini",
+        ".env*": "ini",
+        "**/requirements/*.in": "pip-requirements",
+        "**/requirements/*.txt": "pip-requirements",
+        "*logs.txt": "log",
+        "*.logs*": "log",
+        "*Makefile": "makefile",
+        "docker-compose*.yml": "dockercompose",
+        "Dockerfile*": "dockerfile"
+      },
     "pylint.args": [
         "--rcfile=clients/python/.pylintrc"
     ]

clients/python/LICENSE renamed to LICENSE

@@ -2,6 +2,13 @@ include ./scripts/common.Makefile
 
 PYTHON_DIR    := $(CLIENTS_DIR)/python
 
+
+.vscode/%.json: .vscode/%.template.json
+	$(if $(wildcard $@), \
+	@echo "WARNING #####  $< is newer than $@ ####"; diff -uN $@ $<; false;,\
+	@echo "WARNING ##### $@ does not exist, cloning $< as $@ ############"; cp $< $@)
+
+
 .PHONY: info
 info: ## general information
 	# system
@@ -13,30 +20,32 @@ info: ## general information
 	@which python
 	@pip list
 	# API
-	@echo  ' title        : ' $(shell bash $(SCRIPTS_DIR)/jq.bash -r .info.title $(REPO_ROOT)/api/openapi.json)
-	@echo  ' version      : ' $(shell bash $(SCRIPTS_DIR)/jq.bash -r .info.version $(REPO_ROOT)/api/openapi.json)
+	@echo  ' title        : $(shell bash $(SCRIPTS_DIR)/jq.bash -r .info.title $(REPO_ROOT)/api/openapi.json)'
+	@echo  ' version      : $(shell bash $(SCRIPTS_DIR)/jq.bash -r .info.version $(REPO_ROOT)/api/openapi.json)'
 	# nox
 	@echo nox --list-session
 
 
-.venv:
-	@python3 --version
-	python3 -m venv $@
+.venv: .check-uv-installed
+	@uv venv $@
 	## upgrading tools to latest version in $(shell python3 --version)
-	$@/bin/pip3 --quiet install --upgrade \
-		pip \
+	@uv pip --quiet install --upgrade \
+		pip~=24.0 \
 		wheel \
-		setuptools
-	@$@/bin/pip3 list --verbose
+		setuptools \
+		uv
+	@uv pip list
+
 
 .PHONY: devenv
-devenv: .venv ## create a python virtual environment with dev tools (e.g. linters, etc)
-	$</bin/pip3 --quiet install -r requirements.txt
+devenv: .venv .vscode/settings.json .vscode/launch.json ## create a python virtual environment with dev tools (e.g. linters, etc)
+	@uv pip --quiet install -r requirements.txt
 	# Installing pre-commit hooks in current .git repo
 	@$</bin/pre-commit install
 	@echo "To activate the venv, execute 'source .venv/bin/activate'"
 
 
+
 ## VERSION -------------------------------------------------------------------------------
 
 .PHONY: version-patch version-minor version-major
@@ -53,6 +62,7 @@ define _bumpversion
 endef
 
 ## DOCUMENTATION ------------------------------------------------------------------------
+
 .PHONY: http-doc docs
 docs: ## generate docs
 	# generate documentation
@@ -69,21 +79,3 @@ http-doc: docs ## generates and serves doc
 	# starting doc website
 	@echo "Check site on http://127.0.0.1:50001/"
 	python3 -m http.server 50001 --bind 127.0.0.1
-
-## CLEAN -------------------------------------------------------------------------------
-
-.PHONY: clean-hooks
-clean-hooks: ## Uninstalls git pre-commit hooks
-	@-pre-commit uninstall 2> /dev/null || rm .git/hooks/pre-commit
-
-_git_clean_args := -dx --force --exclude=.vscode --exclude=TODO.md --exclude=.venv --exclude=.python-version --exclude="*keep*"
-
-.check-clean:
-	@git clean -n $(_git_clean_args)
-	@echo -n "Are you sure? [y/N] " && read ans && [ $${ans:-N} = y ]
-	@echo -n "$(shell whoami), are you REALLY sure? [y/N] " && read ans && [ $${ans:-N} = y ]
-
-
-clean: .check-clean ## cleans all unversioned files in project and temp files create by this makefile
-	# Cleaning unversioned
-	@git clean $(_git_clean_args)