Spaces:
Running
Running
Jeremiah Lowin commited on
Update README.md
Browse files
README.md
CHANGED
|
@@ -439,17 +439,18 @@ What insights can you provide about the structure and relationships?"""
|
|
| 439 |
|
| 440 |
#### Prerequisites
|
| 441 |
|
| 442 |
-
FastMCP requires Python 3.10+.
|
| 443 |
|
| 444 |
#### Installation
|
| 445 |
|
| 446 |
-
|
| 447 |
|
| 448 |
-
|
| 449 |
-
git clone https://github.com/
|
| 450 |
cd fastmcp
|
| 451 |
-
|
| 452 |
|
|
|
|
| 453 |
|
| 454 |
```bash
|
| 455 |
uv venv
|
|
@@ -457,21 +458,34 @@ source .venv/bin/activate
|
|
| 457 |
uv sync --frozen --all-extras --dev
|
| 458 |
```
|
| 459 |
|
| 460 |
-
#### Install the pre-commit hooks:
|
| 461 |
|
| 462 |
-
```bash
|
| 463 |
-
pre-commit install
|
| 464 |
-
```
|
| 465 |
|
| 466 |
#### Testing
|
| 467 |
|
| 468 |
-
|
|
|
|
|
|
|
| 469 |
|
| 470 |
|
| 471 |
```bash
|
| 472 |
pytest -vv
|
| 473 |
```
|
| 474 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 475 |
|
| 476 |
#### Opening a Pull Request
|
| 477 |
|
|
@@ -495,6 +509,6 @@ Push your changes to your fork:
|
|
| 495 |
git push origin my-branch
|
| 496 |
```
|
| 497 |
|
| 498 |
-
Feel free to reach out in a GitHub
|
| 499 |
|
| 500 |
</details>
|
|
|
|
| 439 |
|
| 440 |
#### Prerequisites
|
| 441 |
|
| 442 |
+
FastMCP requires Python 3.10+ and [uv](https://docs.astral.sh/uv/).
|
| 443 |
|
| 444 |
#### Installation
|
| 445 |
|
| 446 |
+
Create a fork of this repository, then clone it:
|
| 447 |
|
| 448 |
+
```bash
|
| 449 |
+
git clone https://github.com/YouFancyUserYou/fastmcp.git
|
| 450 |
cd fastmcp
|
| 451 |
+
```
|
| 452 |
|
| 453 |
+
Next, create a virtual environment and install FastMCP:
|
| 454 |
|
| 455 |
```bash
|
| 456 |
uv venv
|
|
|
|
| 458 |
uv sync --frozen --all-extras --dev
|
| 459 |
```
|
| 460 |
|
|
|
|
| 461 |
|
|
|
|
|
|
|
|
|
|
| 462 |
|
| 463 |
#### Testing
|
| 464 |
|
| 465 |
+
Please make sure to test any new functionality. Your tests should be simple and atomic and anticipate change rather than cement complex patterns.
|
| 466 |
+
|
| 467 |
+
Run tests from the root directory:
|
| 468 |
|
| 469 |
|
| 470 |
```bash
|
| 471 |
pytest -vv
|
| 472 |
```
|
| 473 |
|
| 474 |
+
#### Formatting
|
| 475 |
+
|
| 476 |
+
FastMCP enforces a variety of required formats, which you can automatically enforce with pre-commit.
|
| 477 |
+
|
| 478 |
+
Install the pre-commit hooks:
|
| 479 |
+
|
| 480 |
+
```bash
|
| 481 |
+
pre-commit install
|
| 482 |
+
```
|
| 483 |
+
|
| 484 |
+
The hooks will now run on every commit (as well as on every PR). To run them manually:
|
| 485 |
+
|
| 486 |
+
```bash
|
| 487 |
+
pre-commit run --all-files
|
| 488 |
+
```
|
| 489 |
|
| 490 |
#### Opening a Pull Request
|
| 491 |
|
|
|
|
| 509 |
git push origin my-branch
|
| 510 |
```
|
| 511 |
|
| 512 |
+
Feel free to reach out in a GitHub issue or discussion if you have any questions!
|
| 513 |
|
| 514 |
</details>
|