Open
Conversation
This commit introduces a series of modernizations and improvements: - Packaging: - Migrated Python CLI packaging to `pyproject.toml` using Hatch. - Added `hatch-vcs` for versioning from git tags. - Python code for the CLI moved to `src/veertu_cli`. - Vendored dependencies (`click`, `tabulate`) removed in favor of explicit dependencies in `pyproject.toml`. - Code Modernization (Python CLI): - Applied Python 3 compatibility updates (e.g., `items()`, `configparser`, `plistlib.load`). - Added type hints to Python source files (`utils.py`, `formatter.py`, `cli_interface.py`, `veertu_manager.py`) on a best-effort basis due to sandbox limitations with linting/type-checking tools. - Quality Assurance: - Added `ruff` for linting and formatting, and `mypy` for type checking, configured in `pyproject.toml`. - Created a GitHub Actions workflow (`.github/workflows/python_qa.yml`) to run linting, type checking, tests, and build for Python 3.8-3.12 on pushes/PRs. - Set up pre-commit hooks (`.pre-commit-config.yaml`) for `ruff`, `mypy`, and standard file checks. - Testing: - Added a basic test structure in `tests/` with `tests/test_cli_interface.py` using `click.testing.CliRunner`. - Test execution within the development sandbox was not possible due to environment limitations. - Documentation (README.md): - Updated project overview to include the Python CLI. - Added sections for Python CLI installation, usage, packaging, and publishing. - Added a comprehensive "Contributing" section covering codebase structure (high-level for C/Obj-C, detailed for Python), Python CLI development environment setup, running QA checks, and commit message guidelines. - Build System: - Added Hatch scripts for building (`hatch run default:build`) and publishing (`hatch run default:publish`) the Python CLI. - Build verification for the C/Objective-C parts (Xcode) and full Python CLI runtime could not be performed in the sandbox. Hatch build commands for Python also faced sandbox execution issues, but package configuration is complete.
This commit introduces a series of modernizations and improvements: - Packaging: - Migrated Python CLI packaging to `pyproject.toml` using Hatch. - Added `hatch-vcs` for versioning from git tags. - Python code for the CLI moved to `src/veertu_cli`. - Vendored dependencies (`click`, `tabulate`) removed in favor of explicit dependencies in `pyproject.toml`. - Code Modernization (Python CLI): - Applied Python 3 compatibility updates (e.g., `items()`, `configparser`, `plistlib.load`). - Added type hints to Python source files (`utils.py`, `formatter.py`, `cli_interface.py`, `veertu_manager.py`) on a best-effort basis due to sandbox limitations with linting/type-checking tools. - Quality Assurance: - Added `ruff` for linting and formatting, and `mypy` for type checking, configured in `pyproject.toml`. - Created a GitHub Actions workflow (`.github/workflows/python_qa.yml`) to run linting, type checking, tests, and build for Python 3.8-3.12 on pushes/PRs. - Set up pre-commit hooks (`.pre-commit-config.yaml`) for `ruff`, `mypy`, and standard file checks. - Testing: - Added a basic test structure in `tests/` with `tests/test_cli_interface.py` using `click.testing.CliRunner`. - Test execution within the development sandbox was not possible due to environment limitations. - Documentation (README.md): - Updated project overview to include the Python CLI. - Added sections for Python CLI installation, usage, packaging, and publishing. - Added a comprehensive "Contributing" section covering codebase structure (high-level for C/Obj-C, detailed for Python), Python CLI development environment setup, running QA checks, and commit message guidelines. - Build System: - Added Hatch scripts for building (`hatch run default:build`) and publishing (`hatch run default:publish`) the Python CLI. - Build verification for the C/Objective-C parts (Xcode) and full Python CLI runtime could not be performed in the sandbox. Hatch build commands for Python also faced sandbox execution issues, but package configuration is complete.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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
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.
No description provided.