Skip to content

Commit 5e42877

Browse files
committed
Update README
1 parent 51f3556 commit 5e42877

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.adoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,19 @@ hsm.close()
7979
----
8080

8181
=== Development
82-
For development of the library, `poetry` is used. To set up the dev
83-
environment, run this command in the root directory of the repository:
82+
This project uses https://docs.astral.sh/uv/[uv] for development.
83+
Follow the uv Getting Started guide to install and configure it.
8484

85-
$ poetry install -E http -E usb
85+
When `uv` is installed and configured you can set up the dev environment for this project by running the following command in the root directory of the repository:
86+
87+
$ uv sync --all-extras
8688

8789
==== Pre-commit checks
8890
This project uses https://pre-commit.com to run several checks on the code
89-
prior to committing. To enable the hooks, run this command in the root
91+
prior to committing. To enable the hooks, run these commands in the root
9092
directory of the repository:
9193

94+
$ uv tool install pre-commit
9295
$ pre-commit install
9396

9497
Once the hooks are installed, they will run automatically on any changed files
@@ -102,15 +105,15 @@ authentication key enabled (as is the case after performing a factory reset).
102105

103106
WARNING: The YubiHSM under test will be factory reset by the tests!
104107

105-
$ poetry run pytest
108+
$ uv run pytest
106109

107110
See pytest documentation for instructions on running a specific test.
108111

109112
By default the tests will connect to a yubihsm-connector running with the
110113
default settings on http://localhost:12345. To change this, use the `--backend`
111114
argument, eg:
112115

113-
$ poetry run pytest --backend "yhusb://"
116+
$ uv run pytest --backend "yhusb://"
114117

115118
Access to the device requires proper permissions, so either use sudo or setup a
116119
udev rule. Sample udev configuration can be found
@@ -120,13 +123,13 @@ link:https://developers.yubico.com/YubiHSM2/Component_Reference/yubihsm-connecto
120123

121124
To build the HTML documentation, run:
122125

123-
$ poetry run make -C docs/ html
126+
$ uv run make -C docs/ html
124127

125128
The resulting output will be in docs/_build/html/.
126129

127130
==== Source releases for distribution
128131
Build a source release:
129132

130-
$ poetry build
133+
$ uv build
131134

132135
The resulting .tar.gz and .whl will be created in `dist/`.

0 commit comments

Comments
 (0)