databricks-cli/experimental/python/Makefile

sources = databricks databricks_tests

fmt:
	uv run ruff check --fix $(sources) || true
	uv run ruff format

docs:
	# Python 3.12+ is needed for get_overloads
	uv run --python 3.12 sphinx-build docs docs/_output --fail-on-warning --show-traceback --nitpicky --fresh-env --keep-going

lint:
	# check if lock matches the project metadata
	uv lock --check 

	uv run ruff check $(sources)
	uv run pyright
	uv run ruff format --diff

test:
	uv run python -m pytest databricks_tests --cov=databricks.bundles --cov-report html -vv

build:
	rm -rf build dist
	uv build .

.PHONY: fmt docs lint test build
Setup CI for Python code (#2448) ## Changes Add new CI jobs for testing Python code. These jobs are separate from Golang code because they are executed against a matrix of Python versions, and OS versions are not relevant. We will get coverage with OS versions using acceptance tests. In addition, we don't need to run these tests unless any of the Python code is modified. We use uv as a package manager to provision all CI tools: - pyright to typecheck - ruff to lint and format experimental/python contains a Makefile with target similar to repository root: - make fmt - make lint - make build ## Tests Using CI <!-- How have you tested the changes? --> --- NO_CHANGELOG=true 2025-03-11 10:29:36 +00:00			`sources = databricks databricks_tests`

			`fmt:`
			`uv run ruff check --fix $(sources) \|\| true`
			`uv run ruff format`

[Python] Configure Sphinx docs (#2496) ## Changes Configure Sphinx docs for Python code. There is a lot of customization for Sphinx output to make complex type signatures readable: - Type dicts are not documented, because they exactly follow dataclass schema - Variables are excluded from type signatures After that, when the rest of the code is ready, we can automatically publish docs into gh-pages. ## Tests Adds CI check 2025-03-17 09:18:33 +00:00			`docs:`
			`# Python 3.12+ is needed for get_overloads`
			`uv run --python 3.12 sphinx-build docs docs/_output --fail-on-warning --show-traceback --nitpicky --fresh-env --keep-going`

Setup CI for Python code (#2448) ## Changes Add new CI jobs for testing Python code. These jobs are separate from Golang code because they are executed against a matrix of Python versions, and OS versions are not relevant. We will get coverage with OS versions using acceptance tests. In addition, we don't need to run these tests unless any of the Python code is modified. We use uv as a package manager to provision all CI tools: - pyright to typecheck - ruff to lint and format experimental/python contains a Makefile with target similar to repository root: - make fmt - make lint - make build ## Tests Using CI <!-- How have you tested the changes? --> --- NO_CHANGELOG=true 2025-03-11 10:29:36 +00:00			`lint:`
			`# check if lock matches the project metadata`
			`uv lock --check`

			`uv run ruff check $(sources)`
			`uv run pyright`
			`uv run ruff format --diff`

			`test:`
			`uv run python -m pytest databricks_tests --cov=databricks.bundles --cov-report html -vv`

			`build:`
			`rm -rf build dist`
			`uv build .`
[Python] Configure Sphinx docs (#2496) ## Changes Configure Sphinx docs for Python code. There is a lot of customization for Sphinx output to make complex type signatures readable: - Type dicts are not documented, because they exactly follow dataclass schema - Variables are excluded from type signatures After that, when the rest of the code is ready, we can automatically publish docs into gh-pages. ## Tests Adds CI check 2025-03-17 09:18:33 +00:00
			`.PHONY: fmt docs lint test build`