File tree Expand file tree Collapse file tree 1 file changed +12
-29
lines changed Expand file tree Collapse file tree 1 file changed +12
-29
lines changed Original file line number Diff line number Diff line change @@ -131,41 +131,24 @@ operations on attached esp32 devices:
131131
132132## Installation
133133
134- First, copy this github repo into a folder somewhere:
134+ ### Install from PYPI
135+
136+ - Using pip: ` pip install mp-image-tool-esp32 ` , or
137+ - Using uv: ` uv tool install mp-image-tool-esp32 ` .
138+
139+ ### Install from github source
140+
141+ I recommend using [ ` uv ` ] ( https://docs.astral.sh/uv/ ) to install and manage
142+ dependencies and dev environments.
135143
136144``` bash
137145git clone https://github.com/glenn20/mp-image-tool-esp32
138146cd mp-image-tool-esp32
147+ uv build # To build an installable .whl file
148+ uv tool install dist/mp_image_tool_esp32-0.0.12-py3-none-any.whl
139149```
140150
141- If you use a python virtual environment (recommended), make sure it is active.
142-
143- I recommend using [ ` uv ` ] ( https://docs.astral.sh/uv/ ) (` pip install uv ` ) to
144- install and manage dependencies and dev environments.
145-
146- To install in your python environment:
147-
148- - Install in "editable mode":
149-
150- ``` bash
151- pip install -e .
152- ```
153-
154- - OR build and install a distributable ` .whl ` package
155-
156- ``` bash
157- uvx --from build pyproject-build --installer uv
158- pip install dist/mp_image_tool_esp32-0.0.5-py3-none-any.whl
159- ```
160-
161- You may prefer to use ` python -m build ` to build the ` .whl ` files instead.
162-
163- - To run the tests:
164-
165- ``` bash
166- uv run pytest # To run the tests
167- uv run tox # Using `tox` to run the tests for multiple python versions
168- ```
151+ To run the tests: ` uv run pytest ` or ` uv run tox ` .
169152
170153## Examples
171154
You can’t perform that action at this time.
0 commit comments