Merge pull request #7 from thunderock/better_developer_experience

started adding tests for node2vec

Author: thunderock

.github/workflows/tests.yml

@@ -70,7 +70,7 @@ jobs:
         run: timeout 10s poetry run pip --version || rm -rf .venv
 
       - name: Uninstall typing dependencies
-        run: poetry install --only main --only test -vvv
+        run: poetry install -vvv
 
       - name: Test
         run: |

.vscode/extensions.json

@@ -0,0 +1,13 @@
+
+{
+    "recommendations": [
+        "GitHub.copilot",
+        "GitHub.copilot-chat",
+        "ms-python.python",
+        "ms-python.black-formatter",
+        "charliermarsh.ruff",
+        "ms-python.mypy-type-checker",
+        "eamodio.gitlens",
+        "ms-vscode.makefile-tools",
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,84 @@
+{
+    "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/CVS": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "**/__pycache__" : true,
+        "**/node_modules/" : true,
+        "**/.mypy_cache" : true,
+        "**/.metals" : true,
+        "**/.pytest_cache" : true,
+        "**/.ruff_cache" : true,
+        ".venvs" : true,
+        "**/*.egg-info" : true,
+    },
+    "files.associations": {
+        "*.log.*": "log"
+    },
+
+    "editor.insertSpaces": true,
+    "files.trimTrailingWhitespace": true,
+    "[markdown]": {
+        "files.trimTrailingWhitespace": false,
+    },
+    "[python]" : {
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "ms-python.black-formatter",
+    },
+
+    // ==== Autocomplete issues ========
+
+    // Auto import
+    "python.analysis.autoImportCompletions" : true,
+    "python.analysis.packageIndexDepths" : [
+        {
+            "name": "graph_ml",
+            "depth": 4
+        },
+    ],
+
+    // ==== Linting ===
+    // linter
+    "flake8.enabled" : false,
+    "isort.enabled" : false,
+    "ruff.enable": true,
+    "ruff.lint.args": [
+        "--config=pyproject.toml",
+        "--extend-ignore=I",
+    ],
+
+    // mypy - typechecker
+    "mypy-type-checker.importStrategy": "fromEnvironment",
+    "mypy-type-checker.args": ["--config-file", "pyproject.toml"],
+
+    // code formatter - black
+    "black-formatter.importStrategy": "fromEnvironment",
+    "black-formatter.args": ["--config", "${workspaceFolder}/pyproject.toml"],
+
+    // ====== pytest =====
+    // See linting re passing config path.
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": ["-c", "${workspaceFolder}/pyproject.toml"],
+
+
+    // === Integrated terminal ====
+    "terminal.integrated.profiles.linux": {
+        // Ensure the default integrated terminal (bash) respects .bash_profile
+        // https://superuser.com/questions/1209366/win10-vs-code-integrated-bash-not-loading-bash-profile
+        "bash": {
+            "path": "bash",
+            "args": ["--init-file", "${workspaceFolder}/.vscode/start-terminal.sh"],
+        },
+    },
+
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
+    "python.envFile": "${workspaceFolder}/.env",
+
+    "github.copilot.enable": {
+        "*": true,
+    }
+
+}

.vscode/start-terminal.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+echo "Init vscode integrated terminal"
+
+ENV_FILE=".env"
+VENV_DIR=".venv/bin/activate"
+
+if test -f ~/.bash_profile; then
+    echo "Running ~/.bash_profile"
+    source ~/.bash_profile
+fi
+
+if test -f "$ENV_FILE"; then
+    echo "Exporting env vars in $ENV_FILE"
+    set -o allexport
+    source "$ENV_FILE"
+    set +o allexport
+fi
+
+if test -f "$VENV_DIR"; then
+    echo "Activating virtualenv"
+    source "$VENV_DIR"
+fi

Makefile

@@ -16,37 +16,32 @@ ifeq ($(OS),Darwin)
 else
 	@echo "Linux"
 endif
-	@poetry config virtualenvs.in-project true
-	@poetry install --only main -vvv
-
-.PHONY: setup_all
-setup_all:
 	@echo "setting up..."
 	@poetry config virtualenvs.in-project true
-	@poetry install --only main --only jupyter --only test --only lint -vvv
+	@poetry install --only main --only test -vvv
 	@poetry run poetry run jupyter contrib nbextension install --user
 	@poetry run jupyter nbextension enable --py codeium --user
 	@poetry run jupyter serverextension enable --py codeium --user
 
 .PHONY: format
 format:
 	@echo "formatting..."
-	@poetry install --only lint
+	@poetry install
 	@poetry run black .
 	# ruff fix
 	@poetry run pre-commit run --all-files --config .pre-commit-config.yaml
 
 .PHONY: run_tests
 run_tests:
 	@echo "running tests..."
-	@poetry install --only main --only test -vvv
+	@poetry install -vvv
 	@poetry run pytest -q tests
 
 .PHONY: run_notebook
 run_notebook:
 	@echo "running notebook..."
 	@poetry config virtualenvs.in-project true
-	@poetry install --only main --only jupyter -vvv
+	@poetry install --only main -vvv
 	@poetry run poetry run jupyter contrib nbextension install --user
 	@poetry run jupyter nbextension enable --py codeium --user
 	@poetry run jupyter serverextension enable --py codeium --user