Skip to content

Commit fd031b4

Browse files
committed
docs: update development setup instructions to use uv
- Changed installation commands from pip to uv pip for better dependency management - Updated test running instructions to use uv run pytest - Added examples for running integration and unit tests separately
1 parent 2a1e6ac commit fd031b4

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

docs/README-DEV.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,44 @@ Welcome to the MCP for Unity development environment! This directory contains to
99

1010
### Installing Development Dependencies
1111

12-
To contribute or run tests, you need to install the development dependencies:
12+
To contribute or run tests, you need to install the development dependencies using `uv`:
1313

1414
```bash
1515
# Navigate to the server source directory
1616
cd MCPForUnity/UnityMcpServer~/src
1717

1818
# Install the package in editable mode with dev dependencies
19-
pip install -e .[dev]
19+
uv pip install -e ".[dev]"
2020
```
2121

2222
This installs:
2323

24-
- **Runtime dependencies**: `httpx`, `mcp`, `pydantic`, `tomli`
25-
- **Development dependencies**: `pytest`, `pytest-anyio`
24+
- **Runtime dependencies**: `httpx`, `fastmcp`, `mcp`, `pydantic`, `tomli`
25+
- **Development dependencies**: `pytest`, `pytest-asyncio`
2626

2727
### Running Tests
2828

2929
```bash
30-
# From the repo root
31-
pytest tests/ -v
30+
# From the server source directory
31+
cd MCPForUnity/UnityMcpServer~/src
32+
uv run pytest tests/ -v
3233
```
3334

34-
Or if you prefer using Python module syntax:
35+
Or from the repo root:
36+
37+
```bash
38+
# Using uv from the server directory
39+
cd MCPForUnity/UnityMcpServer~/src && uv run pytest tests/ -v
40+
```
41+
42+
To run only integration tests:
43+
```bash
44+
uv run pytest tests/ -v -m integration
45+
```
3546

47+
To run only unit tests:
3648
```bash
37-
python -m pytest tests/ -v
49+
uv run pytest tests/ -v -m unit
3850
```
3951

4052
## 🚀 Available Development Features

0 commit comments

Comments
 (0)