uv improvements

.github/workflows/lint.yml

@@ -23,6 +23,8 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
 
       - name: Check lockfile
         run: uv lock --check
@@ -31,9 +33,9 @@ jobs:
         uses: ts-graphviz/setup-graphviz@v1
 
       - name: Run mypy
-        run: uv run --python ${{ matrix.python-version }} mypy automata/**/*.py tests/*.py
+        run: uv run mypy automata/**/*.py tests/*.py
 
       - name: Run ruff
         run: |
-          uv run --python ${{ matrix.python-version }} ruff check .
-          uv run --python ${{ matrix.python-version }} ruff format --check .
+          uv run ruff check .
+          uv run ruff format --check .

.github/workflows/tests.yml

@@ -23,6 +23,8 @@ jobs:
 
       - name: Install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
 
       - name: Check lockfile
         run: uv lock --check
@@ -32,8 +34,8 @@ jobs:
 
       - name: Test with nose2
         run: |
-          uv run --python ${{ matrix.python-version }} coverage run -m nose2 tests
-          uv run --python ${{ matrix.python-version }} coverage lcov -o cover/coverage.lcov
+          uv run coverage run -m nose2 tests
+          uv run coverage lcov -o cover/coverage.lcov
 
       - name: Run Coveralls
         uses: coverallsapp/github-action@master

.gitignore

@@ -19,6 +19,7 @@ coverage.xml
 nosetests.xml
 
 # Required packages
+.venv
 .virtualenv
 .spyproject
 

.vscode/settings.json

@@ -1,7 +1,5 @@
 {
-  "python.analysis.extraPaths": [
-    ".virtualenv"
-  ],
+  "python.analysis.extraPaths": [".virtualenv"],
   "[python]": {
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "charliermarsh.ruff",

CONTRIBUTING.md

@@ -31,7 +31,7 @@ observe the following guidelines when submitting pull requests for new fixes or
 features:
 
 1. All new code must comply with the enabled ruff lint rules.
-If you install Automata with `virtualenv`, the `ruff`
+If you install Automata dependencies with [`uv`](https://github.com/astral-sh/uv), the `ruff`
 package should be available to you for this purpose with the config in `pyproject.toml`.
 The included VSCode configuration is set to run this formatting on save.
 
@@ -41,7 +41,7 @@ In addition, new code must include type annotations and pass typechecking run wi
 2. Whether you are introducing a bug fix or a new feature, you *must* add tests
 to verify that your code additions function correctly and break nothing else.
 
-3. Please run `coverage run -m nose2 && coverage report` and ensure that your
+3. Please run `uv run coverage run -m nose2 && uv run coverage report` and ensure that your
 changes are covered.
 
 4. If you are adding a new feature or changing behavior, please
@@ -52,30 +52,35 @@ run the documentation site locally, install the documentation dependencies
 with:
 
 ```sh
-pip install -r requirements.dev.txt
+uv sync --group docs
 ```
 
 Then, start the local server with the following command:
 
 ```sh
-mkdocs serve
+uv run mkdocs serve
 ```
 
 
-### Configuring a virtualenv
+### Setting up your environment
 
-The dependencies for the project and best run inside a `virtualenv`. For
-instructions on how to configure virtual environments in Python, please see the
-[Virtual Environments](https://docs.python-guide.org/dev/virtualenvs/)
-section of the Hitchhiker's Guide to Python.
+The dependencies for the project are best managed with [`uv`][uv]. For
+instructions on how to install `uv`, see the [uv documentation][installation].
 
-### Installing project dependencies
+[uv]: https://github.com/astral-sh/uv
+[installation]: https://github.com/astral-sh/uv#installation
 
-You can install all project dependencies via `pip` (assuming your project
-virtualenv is active):
+To create a virtual environment and install all project dependencies (including
+dev dependencies), run:
 
 ```sh
-pip install -r requirements.txt
+uv sync
+```
+
+To install all dependencies related to the documentation site, run:
+
+```sh
+uv sync --group docs
 ```
 
 #### Troubleshooting pygraphviz
@@ -85,23 +90,17 @@ installing dependencies, try running:
 
 ```sh
 brew install graphviz
-python3 -m pip install -U --no-cache-dir  \
-        --config-settings="--global-option=build_ext" \
-        --config-settings="--global-option=-I$(brew --prefix graphviz)/include/" \
-        --config-settings="--global-option=-L$(brew --prefix graphviz)/lib/" \
-        pygraphviz==1.10
-# Proceed to install other dependencies
-pip install -r requirements.txt
+# Proceed to install dependencies
+uv sync
 ```
 
 ### Running unit tests
 
 The project's unit tests are written using [unittest][unittest] and run using
-the [nose2][nose2] Python package. You can run all unit tests via the `nose2`
-command.
+the [nose2][nose2] Python package. You can run all unit tests via the following command:
 
 ```sh
-nose2
+uv run nose2
 ```
 
 [unittest]: https://docs.python.org/3/library/unittest.html
@@ -111,17 +110,17 @@ nose2
 
 The project currently boasts high code coverage across all source files. New
 contributions are expected to maintain this high standard. You can view the
-current coverage report via the `coverage` command:
+current coverage report via the following commands:
 
 ```sh
-coverage run -m nose2
-coverage report
+uv run coverage run -m nose2
+uv run coverage report
 ```
 
 If the coverage ever decreases, you can generate and open a detailed HTML view
 of the coverage report like so:
 
 ```sh
-coverage html
+uv run coverage html
 open htmlcov/index.html
 ```

pyproject.toml

@@ -15,10 +15,10 @@ keywords = [
 ]
 license = "MIT"
 license-files = ["LICENSE.txt"]
-authors = [{ name = 'Caleb Evans', email = '[email protected]' }]
+authors = [{ name = "Caleb Evans", email = "[email protected]" }]
 maintainers = [
-    { name = 'Caleb Evans', email = '[email protected]' },
-    { name = 'Eliot W. Robson', email = '[email protected]' },
+    { name = "Caleb Evans", email = "[email protected]" },
+    { name = "Eliot W. Robson", email = "[email protected]" },
 ]
 dependencies = [
     "networkx>=2.6.2",
@@ -41,11 +41,7 @@ classifiers = [
 
 # Per https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies
 [project.optional-dependencies]
-visual = [
-    "coloraide>=1.8.2",
-    "manim>=0.19.0",
-    "pygraphviz>=1.10",
-]
+visual = ["coloraide>=1.8.2", "manim>=0.19.0", "pygraphviz>=1.10"]
 
 [tool.setuptools.package-data]
 "automata" = ["py.typed"]
@@ -119,8 +115,6 @@ select = [
     "I",
     # Perflint
     "PERF",
-    # flake8-executable
-    "EXE",
 ]