Convert `setup.py` to `pyproject.toml` #593

mariocj89 · 2026-01-13T17:23:41Z

Summary

Move to declarative packaging to provide better tooling integration and build isolation (by enabling python-build).

This will run the build in isolation with the environment and being explicit about the dependencies that are used to build the sdists and bdists, making sure that the build is reproducible and isolated.

The check for the version compatibility has been moved to a unit test, to move any scripting out of the project metadata.

Checklist

Delete items not relevant to your PR:

Unit and integration tests covering the common scenarios were added
A human-readable description of the changes was provided to include in CHANGELOG
For significant changes, documentation in https://github.com/ClickHouse/clickhouse-docs was updated with further explanations or tutorials

Let me know if you want me to add things to changelog/docs.

Relates to #592

Note

Moves packaging to declarative config and modern build tooling.

Replaces setup.py with pyproject.toml (PEP 517/518): defines build backend, project metadata, dependencies, packages, package data, and dynamic version from dbt.adapters.clickhouse.__version__
Updates PyPI workflow to install build/twine and build via python -m build
Adds tests/unit/test_version_compatibility.py to assert adapter version <= installed dbt-core version

^{Written by Cursor Bugbot for commit 08c5987. This will update automatically on new commits. Configure here.}

CLAassistant · 2026-01-13T17:23:47Z

All committers have signed the CLA.

tests/unit/test_version_compatibility.py

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

pyproject.toml

tests/unit/test_version_compatibility.py

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyproject.toml

tests/unit/test_version_compatibility.py

pyproject.toml

tests/unit/test_version_compatibility.py

mariocj89 · 2026-01-14T08:49:15Z

setup.py

-    platforms='any',
-    classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'License :: OSI Approved :: Apache Software License',


You have a classifier as license apache but in the license file you say "MIT". Under what license is this project released?

mariocj89 · 2026-01-14T08:51:31Z

setup.py

-        'dbt-adapters>=1.16.7,<1.17',  # This version should be dbt-adapters>=1.16.7,<2.0, but keeping it fixed for now to avoid unexpected issues. We need to frequently update it.
-        'clickhouse-connect>=0.10.0',
-        'clickhouse-driver>=0.2.10',
-        'setuptools>=0.69',


btw, I assumed this was a mistake and you meant version 69.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-14T09:47:23Z

tests/unit/test_version_compatibility.py

+
+
+def test_version_compatibility():
+    """Check our version is never newer than dbts version"""


Typo in the comment: "dbts version" should be "dbt's version" or "dbt version".

Suggested change

"""Check our version is never newer than dbts version"""

"""Check our version is never newer than dbt's version"""

Copilot · 2026-01-14T09:47:23Z

pyproject.toml

@@ -1,3 +1,55 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]


The setuptools version requirement was changed from "setuptools>=0.69" in setup.py to "setuptools>=69" in both the build-system requirements and runtime dependencies. This is a significant increase (from version 0.69 to version 69.x) and may break installations on older systems. While this may be intentional for the migration to pyproject.toml, please verify this is the intended version requirement change and ensure it's documented in the changelog.

For @koletzilla to confirm if this is needed and it was a mistake (the runtime one, the build time one should not matter)

Move to declarative packaging to provide better tooling integration and build isolation (by enabling `python-build`). This will run the build in isolation with the environment and being explicit about the dependencies that are used to build the sdists and bdists, making sure that the build is reproducible and isolated. The check for the version compatibility has been moved to a unit test, to move any scripting out of the project metadata.

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

cursor · 2026-01-16T16:06:59Z

pyproject.toml

+[tool.setuptools.package-data]
+"dbt.include.clickhouse" = [
+    "dbt_project.yml",
+    "sample_profiles.yml",


Package data references non-existent file

Medium Severity

The package data configuration references sample_profiles.yml, but this file doesn't exist in the repository. The original setup.py did not include this file in its package_data configuration, so this appears to be an erroneous addition during the migration to pyproject.toml. While the build won't fail (setuptools silently skips missing files), the package won't include the expected sample profile that might be needed by users.

cursor · 2026-01-16T16:06:59Z

tests/unit/test_version_compatibility.py

+        f"Invalid metadata in pyproject.toml: package_version={clickhouse_version_str} is greater than "
+        f"dbt version. The adapter version should indicate the minimum supported "
+        f"dbt version. Current installed dbt-core version is {dbt_version_str}."
+    )


Version test semantics differ from original build check

Medium Severity

The new version compatibility test has fundamentally different semantics from the original setup.py check. The original checked if the package version started with a hardcoded "1.9" string (static, build-time validation). The new test compares clickhouse_version <= dbt_version against the installed dbt-core (dynamic, test-time validation). This causes test failures when running against the minimum supported dbt-core>=1.9 (e.g., 1.9.0) while the adapter is 1.9.7, since Version("1.9.7") <= Version("1.9.0") is False. The original protection against misaligned version bumps is also lost.

Copilot AI review requested due to automatic review settings January 13, 2026 17:23

Copilot started reviewing on behalf of mariocj89 January 13, 2026 17:24 View session

cursor bot reviewed Jan 13, 2026

View reviewed changes

tests/unit/test_version_compatibility.py Show resolved Hide resolved

Copilot AI reviewed Jan 13, 2026

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

tests/unit/test_version_compatibility.py Show resolved Hide resolved

tests/unit/test_version_compatibility.py Outdated Show resolved Hide resolved

mariocj89 force-pushed the pu/modernize-packaging branch 2 times, most recently from f5db213 to 9fc12fd Compare January 13, 2026 17:42

mariocj89 requested a review from Copilot January 13, 2026 17:43

Copilot started reviewing on behalf of mariocj89 January 13, 2026 17:43 View session

mariocj89 force-pushed the pu/modernize-packaging branch from 9fc12fd to 98188bd Compare January 13, 2026 17:46

Copilot AI reviewed Jan 13, 2026

View reviewed changes

pyproject.toml Show resolved Hide resolved

tests/unit/test_version_compatibility.py Show resolved Hide resolved

pyproject.toml Show resolved Hide resolved

pyproject.toml Outdated Show resolved Hide resolved

cursor bot reviewed Jan 13, 2026

View reviewed changes

tests/unit/test_version_compatibility.py Outdated Show resolved Hide resolved

mariocj89 force-pushed the pu/modernize-packaging branch from 98188bd to db34b5e Compare January 14, 2026 08:52

mariocj89 requested a review from Copilot January 14, 2026 09:38

Copilot started reviewing on behalf of mariocj89 January 14, 2026 09:38 View session

mariocj89 commented Jan 14, 2026

View reviewed changes

Copilot AI reviewed Jan 14, 2026

View reviewed changes

koletzilla added this to the v1.10.0 milestone Jan 15, 2026

BentsiLeviav requested a review from koletzilla January 15, 2026 10:54

mariocj89 force-pushed the pu/modernize-packaging branch from db34b5e to 08c5987 Compare January 16, 2026 16:00

cursor bot reviewed Jan 16, 2026

View reviewed changes



		def test_version_compatibility():
		"""Check our version is never newer than dbts version"""

		@@ -1,3 +1,55 @@
		[build-system]
		requires = ["setuptools>=69", "wheel"]

Convert setup.py to pyproject.toml #593

Are you sure you want to change the base?

Convert setup.py to pyproject.toml #593

Conversation

mariocj89 commented Jan 13, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

CLAassistant commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mariocj89 Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

mariocj89 Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

mariocj89 Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Jan 16, 2026

Choose a reason for hiding this comment

Package data references non-existent file

Uh oh!

cursor bot Jan 16, 2026

Choose a reason for hiding this comment

Version test semantics differ from original build check

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Convert `setup.py` to `pyproject.toml` #593

Convert `setup.py` to `pyproject.toml` #593

mariocj89 commented Jan 13, 2026 •

edited by cursor bot

Loading

CLAassistant commented Jan 13, 2026 •

edited

Loading