.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: gouline # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/codeql-analysis.yml

@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -55,7 +55,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     # - name: Autobuild
-    #   uses: github/codeql-action/autobuild@v2
+    #   uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,13 +69,16 @@ jobs:
 
     - uses: actions/setup-python@v2
       with:
-        python-version: "3.8.x"
+        python-version: "3.9.x"
 
-    - name: Requirements
-      run: make requirements
+    - name: Install uv
+      run: pipx install uv  
+
+    - name: Dependencies
+      run: make dependencies
 
     - name: Build
       run: make build
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/master.yml

@@ -6,27 +6,31 @@ on:
       - master
   release:
     types:
-      - created
+      - released
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.8.18"
+          python-version: "3.9"
 
-      - name: Requirements
-        run: make requirements
+      - name: Install uv
+        run: pipx install uv
+
+      - name: Dependencies
+        run: make dependencies
 
       - name: Build
+        env:
+          SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.release.tag_name }}
         run: make build
 
       - name: Publish a Python distribution to PyPI
         if: github.event_name == 'release'
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/pull_request.yml

@@ -7,35 +7,30 @@ on:
 
 jobs:
   validate:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.8.18"
+          python-version: "3.9"
 
-      - uses: actions/cache@v2
+      - name: Install uv
+        run: pipx install uv
+
+      - uses: actions/cache@v4
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+          path: .venv
+          key: venv-${{ runner.os }}-${{ hashFiles('**/uv.lock') }}
 
-      - name: Requirements
-        run: make requirements
+      - name: Dependencies
+        run: make dependencies
 
       - name: Build
         run: make build
 
-      - name: Formatting check (black)
-        run: make check-fmt
-
-      - name: Imports ordering check (isort)
-        run: make check-imports
-
-      - name: Lint Python check (pylint)
-        run: make check-lint-python
+      - name: Lint check (ruff)
+        run: make check-lint
 
       - name: Type check (mypy)
         run: make check-type

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing Guidelines
+
+This project would not be here without its community, so contributions have and will always be welcome!
+
+## Issues
+
+When reporting a bug, please create an [issue](https://github.com/gouline/issues) and provide as much content as humanly possible:
+
+* Package version (`dbt-metabase --version` or `pip show dbt-metabase`)
+* Environment details, e.g. operating system, cloud provider, database
+* Steps to reproduce
+* Expected vs actual results
+* Sample code, logs, screenshots
+
+## Pull Requests
+
+Code contributions must be reviewed by the maintainer in a [pull request](https://github.com/gouline/pulls). This project only has one maintainer, so please be patient if the review process takes days or weeks.
+
+Unless your change is a bug fix or an incremental addition, consider proposing your approach in an issue first. While your contributions are appreciated, not everything is suitable for this project, and seeking feedback in advance avoids wasting your time implementing something that gets rejected.
+
+### Validation
+
+While checks and tests are run automatically on pull requests, GitHub Actions requires maintainers to manually approve new contributors for security reasons. This means you could spend days waiting for a code review only to be immediately rejected because validation failed. To avoid this, please **run checks locally before you commit**!
+
+To execute only checks (you can also run each check separately, e.g. `check-fmt`):
+
+```
+make check
+```
+
+To execute only tests:
+
+```
+make test
+```
+
+The most convenient way to fix formatting and imports, and run checks and tests, with one command:
+
+```
+make pre
+```
+
+### Tests
+
+Any code you contribute **must have unit tests**. Bug fixes in particular require at least one test case that fails before your fix and succeeds afterwards. This helps communicate how your contribution works and ensures no future changes inadvertently break it.
+
+### Sandbox
+
+While developing, it can be useful to have a sandbox with Metabase, dbt and PostgreSQL running locally to test your changes. To start it in [Docker Compose](https://docs.docker.com/compose/), execute the following (see [.env](./sandbox/.env) for ports and credentials):
+
+```
+make sandbox-up
+```
+
+To execute dbt-metabase commands against it:
+
+```
+make sandbox-models
+make sandbox-exposures
+```
+
+Once you are finished, stop the sandbox:
+
+```
+make sandbox-down
+```
+
+#### Recording
+
+Whenever tests require updating Metabase API fixtures, you need to "record" them from the running sandbox instance by executing:
+
+```
+RECORD=true make test
+```
+
+This will run tests against the actual Metabase instance, instead of fixtures, and write those responses to new fixtures. **Many tests will likely fail**, because of timestamps and other transient data, so you need to manually fix those assertions.
+
+## Code of Conduct
+
+All contributors are expected to follow the [PSF Code of Conduct](https://www.python.org/psf/conduct/).
+

Makefile

@@ -1,108 +1,102 @@
-build: clean
-	python3 -m build
-.PHONY: build
+export SETUPTOOLS_SCM_PRETEND_VERSION ?= 0.0.0
 
-clean:
-	rm -rf build dist
-.PHONY: clean
+.PHONY: dependencies
+dependencies:
+	uv sync --no-install-project --all-extras --frozen
 
-requirements:
-	python3 -m pip install \
-		-r requirements.txt \
-		-r requirements-test.txt
-.PHONY: requirements
+.PHONY: upgrade
+upgrade:
+	uv sync --no-install-project --all-extras --upgrade
 
-fix-fmt:
-	black .
-.PHONY: fix-fmt
+.PHONY: build
+build: clean
+	uv run python3 -m build
 
-fix-imports:
-	isort .
-.PHONY: fix-imports
+.PHONY: clean
+clean:
+	rm -rf build dist
 
-fix: fix-fmt fix-imports
 .PHONY: fix
+fix:
+	uv run ruff format .
+	uv run ruff check --fix .
 
-check-fmt:
-	black --check .
-.PHONY: check-fmt
-
-check-imports:
-	isort --check .
-.PHONY: check-imports
+.PHONY: check-lint
+check-lint:
+	uv run ruff format --check .
+	uv run ruff check .
 
-check-lint-python:
-	pylint dbtmetabase
-.PHONY: check-lint-python
-
-check-type:
-	mypy dbtmetabase
 .PHONY: check-type
+check-type:
+	uv run mypy dbtmetabase
 
-check: check-fmt check-imports check-lint-python check-type
 .PHONY: check
+check: check-lint check-type
 
-test:
-	python3 -m unittest tests
 .PHONY: test
+test:
+	rm -rf tests/tmp
+	uv run pytest tests
 
-pre: fix check test
 .PHONY: pre
+pre: fix check test
 
-dist-check: build
-	twine check dist/*
 .PHONY: dist-check
+dist-check: build
+	uv run twine check dist/*
 
-dist-upload: check
-	twine upload dist/*
 .PHONY: dist-upload
+dist-upload: check
+	uv run twine upload dist/*
 
-install: build
-	python3 -m pip uninstall -y dbt-metabase \
-		&& python3 -m pip install dist/dbt_metabase-*-py3-none-any.whl
 .PHONY: install
+install: build
+	uv pip uninstall dbt-metabase \
+		&& uv pip install dist/dbt_metabase-*-py3-none-any.whl
 
-sandbox-up:
-	( cd sandbox && docker-compose up --build --attach app )
 .PHONY: sandbox-up
+sandbox-up:
+	( cd sandbox && docker compose up --build --attach app )
 
-sandbox-down:
-	( cd sandbox && docker-compose down )
 .PHONY: sandbox-up
+sandbox-down:
+	( cd sandbox && docker compose down )
 
+.PHONY: sandbox-models
 sandbox-models:
-	( source sandbox/.env && python3 -m dbtmetabase models \
+	( . sandbox/.env && uv run python3 -m dbtmetabase models \
 		--manifest-path sandbox/target/manifest.json \
 		--metabase-url http://localhost:$$MB_PORT \
 		--metabase-username $$MB_USER \
 		--metabase-password $$MB_PASSWORD \
 		--metabase-database $$POSTGRES_DB \
-		--include-schemas "public",other \
+		--include-schemas "pub*",inventory \
 		--http-header x-dummy-key dummy-value \
+		--order-fields \
 		--verbose )
-.PHONY: sandbox-models
 
+.PHONY: sandbox-exposures
 sandbox-exposures:
 	rm -rf sandbox/models/exposures
 	mkdir -p sandbox/models/exposures
-	( source sandbox/.env && python3 -m dbtmetabase exposures \
+	( . sandbox/.env && uv run python3 -m dbtmetabase exposures \
 		--manifest-path sandbox/target/manifest.json \
 		--metabase-url http://localhost:$$MB_PORT \
 		--metabase-username $$MB_USER \
 		--metabase-password $$MB_PASSWORD \
 		--output-path sandbox/models/exposures \
 		--output-grouping collection \
+		--tag metabase \
 		--verbose )
 
-	( source sandbox/.env && cd sandbox && \
+	( . sandbox/.env && cd sandbox && \
 		POSTGRES_HOST=localhost \
 		POSTGRES_PORT=$$POSTGRES_PORT \
 		POSTGRES_USER=$$POSTGRES_USER \
 		POSTGRES_PASSWORD=$$POSTGRES_PASSWORD \
 		POSTGRES_DB=$$POSTGRES_DB \
 		POSTGRES_SCHEMA=$$POSTGRES_SCHEMA \
-		dbt docs generate )
-.PHONY: sandbox-exposures
+		uv run dbt docs generate )
 
-sandbox-e2e: sandbox-up sandbox-models sandbox-exposures sandbox-down
 .PHONY: sandbox-e2e
+sandbox-e2e: sandbox-up sandbox-models sandbox-exposures sandbox-down