Skip to content

Commit 50b06bd

Browse files
committed
Update README with instructions for uv
1 parent c0c759b commit 50b06bd

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

+5-8
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@
22

33
A cross-platform Python API and daemon for the **Envisalink TPI (DSC)** module.
44

5-
**Requirements:** Python >= 3.11 and [poetry](https://python-poetry.org).
5+
**Requirements:** Python >= 3.11 and [uv](https://docs.astral.sh/uv/).
66

77
## Installation
88

99
1. Clone the repository: `git clone https://github.com/Tokenize/evl-daemon-python.git`
10-
2. Install the requirements using poetry: `poetry install`. If you don't want the development dependencies: `poetry install --no-dev`.
10+
2. Install the requirements using poetry: `uv sync`. If you don't want the development dependencies: `uv sync --no-dev`.
1111

1212
## Usage
1313

14-
1. Create a _config.json_ file and save it to the directory of your choosing. You can use the config.json file as a
15-
template. Ensure that the EVL IP, port number and password are specified.
16-
2. Run evldaemon: `poetry run python3 evldaemon.py --config=<config file path>`
14+
1. Create a _config.json_ file and save it to the directory of your choosing. You can use the included config.json file as a template. Ensure that the EVL IP, port number and password are specified.
15+
2. Run evldaemon: `uv run ./evldaemon.py --config=<config file path>`
1716

1817
## Configuration
1918

@@ -26,7 +25,5 @@ See [config.json](config.json) for configuration for details.
2625
To run all unit tests, run the following:
2726

2827
```bash
29-
poetry run python -m unittest discover test
28+
uv run python -m unittest discover test
3029
```
31-
32-

0 commit comments

Comments
 (0)