Skip to content

Commit 64fb41b

Browse files
authored
docs: add a common developer.md file (#167)
1 parent 9a9e0a4 commit 64fb41b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

DEVELOPER.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Development
2+
3+
Below are the details to set up a development environment and run tests.
4+
5+
## Install
6+
1. Clone the repository:
7+
```bash
8+
git clone https://github.com/googleapis/mcp-toolbox-sdk-python
9+
```
10+
1. Navigate to the package directory:
11+
```bash
12+
cd mcp-toolbox-sdk-python/packages/<PACKAGE_NAME>
13+
```
14+
1. Install the package in editable mode, so changes are reflected without
15+
reinstall:
16+
```bash
17+
pip install -e .
18+
```
19+
1. Make code changes and contribute to the SDK's development.
20+
> [!TIP]
21+
> Using `-e` option allows you to make changes to the SDK code and have
22+
> those changes reflected immediately without reinstalling the package.
23+
24+
## Test
25+
1. Navigate to the package directory if needed:
26+
```bash
27+
cd mcp-toolbox-sdk-python/packages/<PACKAGE_NAME>
28+
```
29+
1. Install the SDK and test dependencies:
30+
```bash
31+
pip install -e .[test]
32+
```
33+
1. Run tests and/or contribute to the SDK's development.
34+
35+
```bash
36+
pytest
37+
```

0 commit comments

Comments
 (0)