Migrate to uv build system #85
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull request overview
This PR migrates the Python packaging infrastructure from the legacy setup.py + pip approach to the modern pyproject.toml + uv build system. This migration follows PEP 517/518/639 standards and aligns with the pattern successfully implemented in keboola/python-http-client.
Key Changes:
- Complete migration to declarative
pyproject.tomlconfiguration - Adoption of
uvfor dependency management and publishing - Updated CI/CD workflows to use uv tooling with blocking ruff checks
- Flake8 configuration improvements following cookiecutter template standards
Reviewed changes
Copilot reviewed 11 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
New project configuration file with metadata, dependencies, and dev dependencies |
uv.lock |
Dependency lock file ensuring deterministic builds across Python 3.8-3.14 |
setup.py |
Removed legacy setup file |
requirements.txt |
Removed in favor of pyproject.toml dependencies |
.flake8 |
New standardized flake8 configuration (renamed from flake8.cfg) |
flake8.cfg |
Removed old configuration file |
LICENSE |
Updated copyright year to 2025 |
tests/test_interface.py |
Line ending normalization (CRLF→LF) and minor unused variable fixes |
tests/test_dao.py |
Fixed star imports, unused variables, and formatting issues |
.github/workflows/deploy.yml |
Updated to use uv for build and publish to PyPI |
.github/workflows/deploy_to_test.yml |
Updated to use uv for Test PyPI publishing |
.github/workflows/push_dev.yml |
Updated to use uv with blocking ruff checks |
.github/workflows/push_main.yml |
Updated to use uv for documentation generation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+49
to
+66
| # # set env | ||
| # interface = CommonInterface(mandatory_params=[]) | ||
| # ` | ||
| # # tests | ||
| # try: | ||
| # interface.validate_config() | ||
| # except Exception: # noeq | ||
| # self.fail("validateConfig() fails on empty Parameters!") | ||
|
|
||
| def test_required_params_missing_fail(self): | ||
| return True | ||
| # set env - missing notbar | ||
| # hdlr = CommonInterface(mandatory_params=['fooBar', 'notbar']) | ||
| # | ||
| # with self.assertRaises(ValueError) as er: | ||
| # hdlr.validate_config(['fooBar', 'notbar']) | ||
| # | ||
| # self.assertEqual('Missing mandatory config parameters fields: [notbar] ', str(er.exception)) |
There was a problem hiding this comment.
This comment appears to contain commented-out code.
Suggested change
| # # set env | |
| # interface = CommonInterface(mandatory_params=[]) | |
| # ` | |
| # # tests | |
| # try: | |
| # interface.validate_config() | |
| # except Exception: # noeq | |
| # self.fail("validateConfig() fails on empty Parameters!") | |
| def test_required_params_missing_fail(self): | |
| return True | |
| # set env - missing notbar | |
| # hdlr = CommonInterface(mandatory_params=['fooBar', 'notbar']) | |
| # | |
| # with self.assertRaises(ValueError) as er: | |
| # hdlr.validate_config(['fooBar', 'notbar']) | |
| # | |
| # self.assertEqual('Missing mandatory config parameters fields: [notbar] ', str(er.exception)) | |
| def test_required_params_missing_fail(self): | |
| return True |
Comment on lines
+1034
to
+1048
| # def test_file_manifest(self): | ||
| # cfg = docker.Config() | ||
| # some_file = os.path.join(tempfile.mkdtemp('kbc-test') + 'someFile.txt') | ||
| # cfg.write_file_manifest(some_file, file_tags=['foo', 'bar'], | ||
| # is_public=True, is_permanent=False, | ||
| # notify=True) | ||
| # manifest_filename = some_file + '.manifest' | ||
| # with open(manifest_filename) as manifest_file: | ||
| # config = json.load(manifest_file) | ||
| # self.assertEqual( | ||
| # {'is_public': True, 'is_permanent': False, 'notify': True, | ||
| # 'tags': ['foo', 'bar']}, | ||
| # config | ||
| # ) | ||
| # os.remove(manifest_filename) |
There was a problem hiding this comment.
This comment appears to contain commented-out code.
Suggested change
| # def test_file_manifest(self): | |
| # cfg = docker.Config() | |
| # some_file = os.path.join(tempfile.mkdtemp('kbc-test') + 'someFile.txt') | |
| # cfg.write_file_manifest(some_file, file_tags=['foo', 'bar'], | |
| # is_public=True, is_permanent=False, | |
| # notify=True) | |
| # manifest_filename = some_file + '.manifest' | |
| # with open(manifest_filename) as manifest_file: | |
| # config = json.load(manifest_file) | |
| # self.assertEqual( | |
| # {'is_public': True, 'is_permanent': False, 'notify': True, | |
| # 'tags': ['foo', 'bar']}, | |
| # config | |
| # ) | |
| # os.remove(manifest_filename) | |
| # File manifest behavior is not covered by this test suite. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrate to uv build system
Summary
Migrate from
setup.py+ pip topyproject.toml+uvbuild system, following the same pattern successfully used in keboola/python-http-client.Testing
Changes
Commit 1: flake8 config consistent with cookiecutter template 🍪
flake8.cfg→.flake8(standard naming)tests/test_dao.py: Fixed star imports (F403/F405), unused variables (F841), formattingtests/test_interface.py: Fixed unused variables (F841), line length (E501), normalized CRLF→LF line endingsCommit 2: migrate package configuration to pyproject.toml 📦
pyproject.tomlwith complete project metadata:pygelf,pytz<2021.0,deprecatedflake8,pytest,ruff,pdoc3License :: OSI Approved :: MIT Licenseclassifier (PEP 639 compliance)setup.pyandrequirements.txtLICENSEcopyright to 2025Commit 3: uv 💜
.github/workflows/deploy.yml- production PyPI (triggers on tag creation).github/workflows/deploy_to_test.yml- Test PyPI (manual workflow_dispatch).github/workflows/push_dev.yml- dev branch testing.github/workflows/push_main.yml- docs generationcontinue-on-error)uv versionUV_PUBLISH_TOKEN,UV_PUBLISH_TOKEN_TEST_PYPIuv.lockwith locked dependenciesVersion Strategy
Workflow Strategy
workflow_dispatch- allows testing any tagBreaking Changes
None - this is purely a build system migration. The published package remains functionally identical.
Migration Notes
uv add keboola.componentBenefits
uv.lockNote on Large Diff in test_interface.py
The file had CRLF (Windows) line endings which were normalized to LF (Unix) during flake8 fixes. Actual code changes are minimal (5 lines: unused variables + comment formatting).