Skip to content

Commit 90b80e8

Browse files
committed
docs: Add Development section to README
Add comprehensive development documentation including: - Setup instructions for both uv and tox workflows - uv commands for fast local development - tox commands following OpenStack standards - Testing section with coverage information (85%+) This helps contributors choose their preferred development workflow.
1 parent b532c58 commit 90b80e8

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,76 @@ Get started quickly with the OpenStack MCP server using Claude Desktop
9595
}
9696
```
9797

98+
# Development
99+
100+
## Setup
101+
102+
This project supports both `uv` and `tox` for development and testing.
103+
104+
### Using uv (Fast Local Development)
105+
106+
```bash
107+
# Install dependencies (including dev and test groups)
108+
uv sync
109+
110+
# Run tests
111+
uv run --group test pytest
112+
113+
# Run linting
114+
uv run ruff check src tests
115+
116+
# Format code
117+
uv run ruff format src tests
118+
```
119+
120+
### Using tox (OpenStack Standard)
121+
122+
```bash
123+
# Install tox
124+
pip install tox
125+
# or
126+
uv tool install tox
127+
128+
# Run tests
129+
tox -e py3
130+
131+
# Run linting
132+
tox -e pep8
133+
134+
# Auto-format code
135+
tox -e format
136+
137+
# Generate coverage report
138+
tox -e cover
139+
140+
# Run arbitrary commands in virtualenv
141+
tox -e venv -- <command>
142+
143+
# Test on specific Python version
144+
tox -e py310 # or py311, py312, py313
145+
146+
# List all available environments
147+
tox list
148+
```
149+
150+
## Testing
151+
152+
The project includes comprehensive test coverage (85%+). Tests are located in the `tests/` directory.
153+
154+
```bash
155+
# Run all tests
156+
tox -e py3
157+
158+
# Run with coverage
159+
tox -e cover
160+
161+
# Run with debugger
162+
tox -e debug
163+
164+
# Run specific test file
165+
tox -e py3 -- tests/tools/test_compute_tools.py
166+
```
167+
98168
# Contributing
99169
Contributions are welcome! Please see the [CONTRIBUTING](CONTRIBUTING.rst) file for details on how to contribute to this project.
100170

0 commit comments

Comments
 (0)