Merge pull request #68 from xonsh/anki-uv

feat: Add uv support

Author: anki-code

.github/workflows/test.yml

@@ -39,3 +39,63 @@ jobs:
       run: pip install ".[dev]"
     - name: Run tests
       run: pytest
+
+  e2e-load:
+    name: e2e (${{ matrix.package_manager.name }}, autoload=${{ matrix.autoloading }})
+    needs: testing
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        autoloading: ["true", "false"]
+        package_manager:
+          - { name: setuptools, install: 'pip install ".[dev]"',            run: '' }
+          - { name: poetry,     install: 'poetry install --no-interaction', run: 'poetry run ' }
+          - { name: uv,         install: 'uv sync',                         run: 'uv run ' }
+    steps:
+    - uses: actions/checkout@v5
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: "3.13"
+
+    - name: Install poetry
+      if: matrix.package_manager.name == 'poetry'
+      run: pipx install poetry
+
+    - name: Install uv
+      if: matrix.package_manager.name == 'uv'
+      uses: astral-sh/setup-uv@v6
+
+    - name: Install copier
+      run: pip install 'copier>=9' copier-templates-extensions
+
+    - name: Generate xontrib
+      run: |
+        copier copy --trust --defaults --vcs-ref=HEAD \
+          --data full_name=Test \
+          --data email=test@test.test \
+          --data github_username=test \
+          --data project_name=my-prompt \
+          --data project_short_description=test \
+          --data package_manager=${{ matrix.package_manager.name }} \
+          --data enable_autoloading=${{ matrix.autoloading }} \
+          . _generated
+
+    - name: Install generated xontrib
+      working-directory: _generated/xontrib-my-prompt
+      run: ${{ matrix.package_manager.install }}
+
+    - name: Verify autoloading
+      if: matrix.autoloading == 'true'
+      working-directory: _generated/xontrib-my-prompt
+      run: |
+        ${{ matrix.package_manager.run }}xonsh -c "xontrib list" | tee out.txt
+        grep my_prompt out.txt | grep loaded | grep auto
+
+    - name: Verify manual loading
+      if: matrix.autoloading == 'false'
+      working-directory: _generated/xontrib-my-prompt
+      run: |
+        ${{ matrix.package_manager.run }}xonsh -c 'xontrib load my_prompt; xontrib list' | tee out.txt
+        grep my_prompt out.txt | grep loaded | grep manual

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-A template for creating the <a href="https://github.com/xonsh/xonsh">xonsh</a> contributions called <a href="https://xon.sh/tutorial_xontrib.html">xontribs</a>.
+A template for creating the <a href="https://github.com/xonsh/xonsh">xonsh</a> extensions called <a href="https://xon.sh/tutorial_xontrib.html">xontribs</a>.
 </p>
 
 <p align="center">
@@ -13,7 +13,10 @@ If you like the template click ⭐ on the repo.
 This template includes good pack of prebuilt files:
 
 * `README` with the info and xontrib promotion instructions
-* [`PEP 621`](https://peps.python.org/pep-0621/) or `poetry` based `pyproject.toml` file to make and install PyPi package easily
+* `pyproject.toml` file to make and install PyPi package easily — pick a build backend when prompted by `copier`:
+  * `setuptools` — classic [`PEP 621`](https://peps.python.org/pep-0621/) layout
+  * `poetry` — [Poetry](https://python-poetry.org/) project layout
+  * `uv` — [uv](https://docs.astral.sh/uv/)-managed project with `hatchling` backend and PEP 735 dependency groups
 * `.gitattributes` file to enable Github syntax highlighting for `*.xsh` files
 * `.gitignore` file with standard list of directories to ignore
 * `.github/workflow/push-test.yml` to automatically test the code using Github Actions

copier.yml

@@ -46,6 +46,7 @@ package_manager:
   choices:
     - setuptools
     - poetry
+    - uv
 
 enable_autoloading:
   type: bool

project-template/{{ project_repo_name }}/.github/workflows/test.yml

@@ -26,19 +26,30 @@ jobs:
 {%- if package_manager == 'poetry' %}
     - name: Install poetry
       run: pipx install poetry
+{% elif package_manager == 'uv' %}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        enable-cache: true
 {% endif -%}
 {% raw %}
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }} {% endraw %}
-        cache: {% if package_manager == 'poetry' %}poetry{% else %}pip{% endif %}
+{%- if package_manager == 'poetry' %}
+        cache: poetry
+        cache-dependency-path: pyproject.toml
+{%- elif package_manager == 'uv' %}
+{%- else %}
+        cache: pip
         cache-dependency-path: pyproject.toml
+{%- endif %}
 
     - uses: pre-commit/action@v3.0.0
     - name: Install dependencies
-      run: {% if package_manager == 'poetry' %}poetry install{% else %}pip install ".[dev]"{% endif %}
+      run: {% if package_manager == 'poetry' %}poetry install{% elif package_manager == 'uv' %}uv sync{% else %}pip install ".[dev]"{% endif %}
     - name: Run tests
       run: |
-        xonsh -c "xontrib load {{ project_package_name}}"
-        {% if package_manager == 'poetry' %}poetry run pytest{% else %}pytest{% endif %}
+        {% if package_manager == 'uv' %}uv run {% endif %}xonsh -c "xontrib load {{ project_package_name}}"
+        {% if package_manager == 'poetry' %}poetry run pytest{% elif package_manager == 'uv' %}uv run pytest{% else %}pytest{% endif %}

project-template/{{ project_repo_name }}/README.md

@@ -54,7 +54,7 @@ pre-commit autoupdate
 
 - Bump the version of your package.
 - Create a GitHub release (The release notes are automatically generated as a draft release after each push).
-- And publish with `poetry publish --build` or `twine`
+- And publish with `poetry publish --build`, `uv publish`, or `twine`
 
 ## Credits
 

project-template/{{ project_repo_name }}/pyproject.toml

@@ -71,6 +71,11 @@ xonsh = ">=0.23.0"
 {% if package_manager == 'poetry' %}
 [tool.poetry.group.dev.dependencies]
 pytest = ">=7.0"
+{% elif package_manager == 'uv' %}
+[dependency-groups]
+dev = ["pytest>=7.0"]
+
+[tool.uv]
 {% else %}
 [project.optional-dependencies]
 dev = ["pytest>=7.0"]
@@ -80,6 +85,17 @@ dev = ["pytest>=7.0"]
 [build-system]
 requires = ["poetry-core>=1.3.0"]
 build-backend = "poetry.core.masonry.api"
+{% elif package_manager == 'uv' %}
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+    {% if enable_autoloading %}
+packages = ["{{ py_module_name }}"]
+    {% else %}
+packages = ["xontrib"]
+    {% endif %}
 {% else %}
 [build-system]
 requires = [

project-template/{{ project_repo_name }}/{%if enable_autoloading%}{{ py_module_name }}{%endif%}/main.py

@@ -4,7 +4,7 @@
 def _load_xontrib_(xsh: XonshSession, **_):
 
     # If your xontrib was made only for interactive mode it's good practice to check this before executing.
-    if XSH.env.get("XONSH_INTERACTIVE"):
+    if xsh.env.get("XONSH_INTERACTIVE"):
         var = xsh.env.get("VAR", "default")
         print("Autoloading xontrib: {{ project_repo_name }}")
 

tests/test_generation.py

@@ -8,7 +8,7 @@
 
 
 @pytest.mark.parametrize("autoloading", [False, True])
-@pytest.mark.parametrize("builder", ["setuptools", "poetry"])
+@pytest.mark.parametrize("builder", ["setuptools", "poetry", "uv"])
 def test_it_generates(bake_cookie, builder, autoloading):
     out = bake_cookie(package_manager=builder, enable_autoloading=autoloading)
     expected = get_expected_files(builder, autoloading)