Merge pull request #13 from frizzleqq/fix_test_notebook

Fix test notebook

Author: frizzleqq

README.md

@@ -9,7 +9,7 @@ The project is configured using `pyproject.toml` (Python specifics) and `databri
 | Directory | Description |
 |-----------|-------------|
 | `.github/workflows` | CI/CD jobs to test and deploy bundle |
-| `dab_project` | Python project (Used in Databricks Workflow as Python-Wheel-Task) |
+| `src/dab_project` | Python project (Used in Databricks Workflow as Python-Wheel-Task) |
 | `dbt` | [dbt](https://github.com/dbt-labs/dbt-core) project<br/>* Used in Databricks Workflow as dbt-Task<br/>* dbt-Models used from https://github.com/dbt-labs/jaffle_shop_duckdb |
 | `resources` | Resources such as Databricks Workflows or Databricks Volumes/Schemas<br/>* Python-based workflow: https://docs.databricks.com/aws/en/dev-tools/bundles/python<br/>* YAML-based Workflow: https://docs.databricks.com/aws/en/dev-tools/bundles/resources#job |
 | `scripts` | Python script to setup groups, service principals and catalogs used in a Databricks (Free Edition) workspace |
@@ -131,19 +131,6 @@ uv run ./scripts/setup_workspace.py
 
 ## FAQ
 
-* Why no `src` directory?
-
-   Working in Databricks Git Repos automatically adds the root of the Git Repo to Python `sys.path`.
-
-   This way Notebooks in the Git Repo can run `import dab_project` to import the local Python package during development without explicitly installing the package on the Cluster.
-
-   A Notebook outside the Git Repo can do `import os; os.chdir("/Workspace/Users/...")` to act like it is within the Git Repo.
-
-   Using a `src` directory requires changing the `sys.path` during development (without package installed) in a Databricks Git Repo.
-   ```python
-   import sys
-   sys.path.append("../src")
-   ```
 * Service Principals
 
    For this example, the targets `test` and `prod` use a group and service principals.

databricks.yml

@@ -18,9 +18,9 @@ include:
 
 sync:
   paths:
-    - dab_project/
     - dbt/
     - resources/
+    - src/
     - typings/
     - databricks.yml
     - pyproject.toml

pyproject.toml

@@ -38,28 +38,30 @@ dev = [
 [project.scripts]
 dab-project = "dab_project.cli:main"
 
-[tool.uv.build-backend]
-module-name = "dab_project"
-module-root = ""
-
 [[tool.mypy.overrides]]
 ignore_missing_imports = true
 
 [tool.ruff]
 line-length = 100
 include = [
     "pyproject.toml",
-    "dab_project/**/*.py",
+    "src/**/*.py",
     "resources/**/*.py",
     "scripts/**/*.py",
     "tests/**/*.py",
 ]
+exclude = [
+    "tests/notebook_run_pytest.py"
+]
 
 [tool.ruff.format]
 docstring-code-format = true
 
 [tool.ruff.lint]
-exclude = ["scratch/**/*.py"]
+exclude = [
+    "scratch/**/*.py",
+    "tests/notebook_run_pytest.py"
+]
 select = [
   "E", # pycodestyle
   "W", # pycodestyle
@@ -82,6 +84,7 @@ line-length = 100
 target-version = ['py312']
 
 [tool.pytest.ini_options]
+pythonpath = "src"
 addopts = "-ra -q"
 testpaths = [
     "tests",

scratch/README.md

@@ -1,7 +1,11 @@
-# Notebooks
+# Scratch
 
-This folder contains Databricks Notebook style files (as `.py`).
+This folder is reserved for personal, exploratory notebooks.
+By default these are not committed to Git, as 'scratch' is listed in .gitignore.
 
-They access `dab_project` Python project, so it can be used as:
-* Databricks Git Repo
-* Local IDE (Project installed as 'editable')
+Using the `src` directory requires appending to the `sys.path`:
+
+```python
+import sys
+sys.path.append("../src")
+```