Merge pull request #35 from andrewleech/convert-to-uv

Convert from Poetry to PEP standard pyproject.toml for uv

Author: Josverl

.all-contributorsrc

@@ -70,7 +70,8 @@
             "profile": "https://www.gitlab.com/alelec",
             "contributions": [
                 "mpflash",
-                "test"
+                "test",
+                "tooling"
             ]
         },
         {

.github/copilot-instructions.md

@@ -32,10 +32,9 @@ MPFlash is a command-line tool and Python library for managing MicroPython firmw
 
 # dependencies
 
-- Use uv pip for package management
-- the project is handled by poetry and all dependencies should be added to the pyproject.toml file
-- minimize the number of dependencies
--
+- Use uv for package management
+- The project uses PEP standard pyproject.toml format and all dependencies should be added to the dependencies or optional-dependencies sections
+- Minimize the number of dependencies
 
 # Writing tests
 - when asked to create an MVP - keep the number of tests to a minimum

.github/workflows/pytest_mpflash.yml

@@ -48,11 +48,12 @@ jobs:
                 fetch-tags: true
 
             #----------------------------------------------
-            # poetry is not in the default image
+            # uv is not in the default image
             #----------------------------------------------
-            - name: Install poetry and codecov
-              run: |
-                  pipx install poetry
+            - name: Install the latest version of uv
+              uses: astral-sh/setup-uv@v6
+              with:
+                version: "latest"
 
             - name: Set up Python ${{ matrix.python-version }}
               uses: actions/setup-python@v5
@@ -64,13 +65,13 @@ jobs:
             # install project
             #----------------------------------------------
             - name: Install mpflash & test dependencies
-              run: poetry install --with test
+              run: uv sync --extra test
 
             - name: Test mpflash
               run: |
                   # run once to bootstrap database (test hack)
-                  poetry run mpflash download --board RPI_PICO
-                  poetry run pytest --cov --cov-branch --cov-report=xml
+                  uv run mpflash download --board RPI_PICO
+                  uv run pytest --cov --cov-branch --cov-report=xml
 
             #----------------------------------------------
             # upload coverage stats

docs/contributing.md

@@ -18,7 +18,7 @@ Thank you for your interest in contributing to MPFlash! This guide will help you
 ### Prerequisites
 
 - Python 3.9.2 or later
-- Poetry for dependency management
+- uv for dependency management (recommended) or pip
 - Git for version control
 - A MicroPython board for testing (optional but recommended)
 
@@ -42,10 +42,10 @@ Thank you for your interest in contributing to MPFlash! This guide will help you
 
 ```bash
 # Install development dependencies
-poetry install
+uv sync --all-extras
 
-# Activate virtual environment
-poetry shell
+# Or using pip (if uv not available)
+pip install -e ".[dev,test,perf]"
 ```
 
 ### Environment Configuration
@@ -66,10 +66,10 @@ PYTHONPATH=src                # For development
 
 ```bash
 # Run MPFlash to verify installation
-poetry run mpflash --help
+uv run mpflash --help
 
 # Run tests to ensure everything works
-poetry run pytest
+uv run pytest
 ```
 
 ## Code Style Guidelines
@@ -171,16 +171,13 @@ Use these tools to maintain code quality:
 
 ```bash
 # Format code
-poetry run black mpflash/
+uv run ruff format mpflash/
 
-# Sort imports
-poetry run isort mpflash/
+# Lint and fix code  
+uv run ruff check --fix mpflash/
 
-# Remove unused imports
-poetry run autoflake mpflash/ -r --in-place --remove-all-unused-imports
-
-# Type checking
-poetry run mypy mpflash/
+# Type checking (if mypy is installed)
+uv run mypy mpflash/
 ```
 
 ## Testing
@@ -306,22 +303,22 @@ def test_list_command():
 
 ```bash
 # Run all tests
-poetry run pytest
+uv run pytest
 
 # Run specific test file
-poetry run pytest tests/test_download.py
+uv run pytest tests/test_download.py
 
 # Run tests with coverage
-poetry run pytest --cov=mpflash
+uv run pytest --cov=mpflash
 
 # Run tests with verbose output
-poetry run pytest -v
+uv run pytest -v
 
 # Run tests excluding slow tests
-poetry run pytest -m "not basicgit"
+uv run pytest -m "not basicgit"
 
 # Run tests for specific functionality
-poetry run pytest -k "flash"
+uv run pytest -k "flash"
 ```
 
 ### Test Coverage
@@ -330,8 +327,8 @@ Maintain high test coverage:
 
 ```bash
 # Generate coverage report
-poetry run coverage run -m pytest
-poetry run coverage html
+uv run coverage run -m pytest
+uv run coverage html
 
 # View coverage report
 open htmlcov/index.html
@@ -528,14 +525,11 @@ To add support for a new hardware platform:
 MPFlash uses semantic versioning:
 
 ```bash
-# Patch version (bug fixes)
-poetry version patch
-
-# Minor version (new features)
-poetry version minor
-
-# Major version (breaking changes)
-poetry version major
+# Update version in pyproject.toml manually
+# Or use a tool like bump2version:
+# bump2version patch   # for bug fixes
+# bump2version minor   # for new features  
+# bump2version major   # for breaking changes
 ```
 
 ### Changelog

docs/developer.md

@@ -87,14 +87,14 @@ CREATE TABLE firmwares (
 
 ### Prerequisites
 - Python 3.9.2+
-- Poetry for dependency management
+- uv for dependency management (or pip)
 - Git for version control
 
 ### Installation
 ```bash
 git clone https://github.com/Josverl/mpflash.git
 cd mpflash
-poetry install
+uv sync --all-extras
 ```
 
 ### Environment Variables
@@ -111,13 +111,13 @@ PYTHONPATH=src                # Test source path
 ### Running Tests
 ```bash
 # Run all tests
-poetry run pytest
+uv run pytest
 
 # Run with coverage
-poetry run pytest --cov=mpflash
+uv run pytest --cov=mpflash
 
 # Run specific test categories
-poetry run pytest -m "not basicgit"
+uv run pytest -m "not basicgit"
 ```
 
 ## Code Standards
@@ -355,12 +355,17 @@ Use the configured tasks for development:
 
 ### Version Management
 ```bash
-# Update version in pyproject.toml
-poetry version patch|minor|major
-
-# Build and publish
-poetry build
-poetry publish
+# Update version in pyproject.toml using either
+uv version <new_version>  
+uv version --bump patch 
+# Build package
+uv build
+
+# Publish to PyPI
+# set token in environment variable
+export UV_PUBLISH_TOKEN="pypi-123456789abcdef"
+# uv publish --index testpypi # optionally
+uv publish #
 ```
 
 ### Documentation Updates