feat: update tests and add uv (#21)

Author: shpaker

.github/workflows/doc.yml

@@ -16,15 +16,15 @@ jobs:
       - uses: extractions/setup-just@v3
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
       - uses: actions/checkout@v4
-      - run: |
-          python -m pip install poetry~=1.8.4
-          poetry install --no-ansi --sync
+      - uses: astral-sh/setup-uv@v4
+      - uses: extractions/setup-just@v3
+      - run: uv sync --verbose --no-progress --locked --all-extras
       - run: just doc
       - uses: actions/configure-pages@v4
       - uses: actions/upload-pages-artifact@v3
         with:
           path: _doc/
       - uses: actions/deploy-pages@v4
-        id: deployment
+        id: deployment

.github/workflows/pypi.yml

@@ -1,27 +1,25 @@
 ---
-name: Build
+  name: 👷🏼 pypi
 
-on:
-  release:
-    types: [created]
+  on:
+    release:
+      types: [ created ]
 
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-      - uses: actions/checkout@v3
-      - name: Extract branch name
-        shell: bash
-        run: |
-          echo "##[set-output name=ver;]$(echo ${GITHUB_REF#refs/*/})"
-        id: extract_name_and_version
-      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' pyproject.toml
-      - run: head -n 10 pyproject.toml
-      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' winregistry.py
-      - run: python -m pip install poetry~=1.8.4
-      - run: poetry build
-      - run: poetry config http-basic.pypi __token__ ${{ secrets.PYPI_PASS }}
-      - run: poetry publish
+  jobs:
+    build:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - name: Extract branch name
+          shell: bash
+          run: |
+            echo "##[set-output name=ver;]$(echo ${GITHUB_REF#refs/*/})"
+          id: extract_name_and_version
+        - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' pyproject.toml
+        - run: head -n 10 pyproject.toml
+        - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' winregistry.py
+        - uses: astral-sh/setup-uv@v4
+        - run: uv python install 3.12
+        - run: uv sync --all-extras --dev
+        - run: uv build
+        - run: uv publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}

.github/workflows/robot.yml

@@ -18,14 +18,13 @@ jobs:
           - "3.12"
           - "3.13"
     steps:
-      - uses: extractions/setup-just@v2
       - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.PYTHON_VERSION }}
       - uses: actions/checkout@v4
-      - run: |
-          python -m pip install poetry~=1.8.4
-          poetry install --no-ansi --sync
+      - uses: astral-sh/setup-uv@v4
+      - uses: extractions/setup-just@v3
+      - run: uv sync --verbose --no-progress --locked --all-extras
       - run: just tests
       - uses: actions/upload-artifact@v4
         if: always()

Justfile

@@ -2,16 +2,16 @@ SOURCE_FILE := "winregistry.py"
 TESTS_FILE := "winregistry_tests.robot"
 
 fmt:
-    poetry run ruff format -v {{ SOURCE_FILE }}
+    uv run ruff format -v {{ SOURCE_FILE }}
 
 lint:
-    poetry run ruff check {{ SOURCE_FILE }}
+    uv run ruff check {{ SOURCE_FILE }}
 
 fix:
-    poetry run ruff check --fix --unsafe-fixes {{ SOURCE_FILE }}
+    uv run ruff check --fix --unsafe-fixes {{ SOURCE_FILE }}
 
 tests:
-    poetry run robot {{ TESTS_FILE }}
+    uv run robot {{ TESTS_FILE }}
 
 doc:
-    poetry run libdoc winregistry.robot _doc/winregistry.robot.html
+    uv run libdoc winregistry.robot _doc/winregistry.robot.html

README.md

@@ -3,13 +3,7 @@
 [![PyPI](https://img.shields.io/pypi/v/winregistry.svg)](https://pypi.python.org/pypi/winregistry)
 [![PyPI](https://img.shields.io/pypi/dm/winregistry.svg)](https://pypi.python.org/pypi/winregistry)
 
-A Python library for interacting with the Windows registry
-
-## Features
-
-- Easy to use API for Windows registry operations
-- Supports creating, reading, updating, and deleting registry keys and values
-- Compatible with Robot Framework for automated testing
+A Python library for interacting with the Windows registry. This library provides a simple and intuitive API for performing common registry operations, making it easier to work with the Windows registry in Python applications and automated tests.
 
 ## Installation
 
@@ -92,75 +86,41 @@ with open_key(
 
 ## Usage with [Robot Testing Framework](https://robotframework.org/)
 
+The library provides a Robot Framework library that makes it easy to work with the Windows registry in automated tests. The library is available as `winregistry.robot`.
+
 ### Documentation
 
+For detailed documentation of the Robot Framework library, visit:
 https://shpaker.github.io/winregistry/winregistry.robot
 
-### Example
-
-```robotframework
-*** Variables ***
-${ SUITE_KEY_NAME }       HKLM\\SOFTWARE\\_ROBOT_TESTS_
-${ SHORT_CASE_KEY_NAME }  _CASE_KEY_
-${ CASE_KEY_NAME }        ${ SUITE_KEY_NAME }\\${ SHORT_CASE_KEY_NAME }
-${ VALUE_NAME }           some_testing_value
-
-*** Settings ***
-Library         Collections
-Library         winregistry.robot
-Suite Setup     Create Registry Key  ${ SUITE_KEY_NAME }
-Suite Teardown  Delete Registry Key  ${ SUITE_KEY_NAME }
-
-*** Test Cases ***
-TEST REGISTRY KEYS
-    [Teardown]  Delete Registry Key     ${ CASE_KEY_NAME }
-
-    ${ items } =    Get Registry Key Sub Keys   ${ SUITE_KEY_NAME }
-    List Should Not Contain Value   ${ items }  ${ SHORT_CASE_KEY_NAME }
-    Registry Key Should Not Exist   ${ CASE_KEY_NAME }
-    Create Registry Key             ${ CASE_KEY_NAME }
-    Registry Key Should Exist       ${ CASE_KEY_NAME }
-    ${ items } =    Get Registry Key Sub Keys   ${ SUITE_KEY_NAME }
-    List Should Contain Value       ${ items }  ${ SHORT_CASE_KEY_NAME }
-
-
-TEST REGISTRY VALUES
-    [Setup]     Create Registry Key         ${ CASE_KEY_NAME }
-    [Teardown]  Delete Registry Key         ${ CASE_KEY_NAME }
-
-    ${ items } =    Get Registry Key Values Names   ${ CASE_KEY_NAME }
-    List Should Not Contain Value           ${ items }          ${ VALUE_NAME }
-    Registry Value Should Not Exist         ${ CASE_KEY_NAME }  ${ VALUE_NAME }
-    Create Registry Value                   ${ CASE_KEY_NAME }  ${ VALUE_NAME }  SZ
-    Registry Value Should Exist             ${ CASE_KEY_NAME }  ${ VALUE_NAME }
-    ${ items } =    Get Registry Key Values Names   ${ CASE_KEY_NAME }
-    List Should Contain Value               ${ items }          ${ VALUE_NAME }
-    ${ value } =    Read Registry Value     ${ CASE_KEY_NAME }  ${ VALUE_NAME }
-    Should Be Equal     ${ value.data }     ${ EMPTY }
-    Set Registry Value                      ${ CASE_KEY_NAME }  ${ VALUE_NAME }  Remove me!
-    ${ value } =    Read Registry Value     ${ CASE_KEY_NAME }  ${ VALUE_NAME }
-    Should Be Equal     ${ value.data }     Remove me!
-    Delete Registry Value                   ${ CASE_KEY_NAME }  ${ VALUE_NAME }
-```
+### Example Tests
+
+A complete set of example tests demonstrating various registry operations can be found in the [winregistry_tests.robot](winregistry_tests.robot) file. These tests cover:
+
+- Creating and deleting registry keys
+- Working with nested registry keys
+- Setting and reading registry values
+- Verifying registry key and value existence
+- Enumerating subkeys and values
 
 ## Contributing
 
 Contributions are welcome! Please read our contributing guidelines for more details.
 
 ### Setting Up the Development Environment
 
-We use `poetry` for dependency management and packaging. To set up your development environment, follow these steps:
+We use `uv` for dependency management and packaging. To set up your development environment, follow these steps:
 
-1. Install `poetry` if you haven't already:
+1. Install `uv` if you haven't already:
 
     ```bash
-    pip install poetry
+    pip install uv
     ```
 
 2. Install the project dependencies:
 
     ```bash
-    poetry install --sync
+    uv sync --verbose --no-progress --locked --all-extras
     ```
 
 ### Code Formatting and Linting