fix(#20): correct uv installation instructions in contributing docs #21
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix incorrect uv installation instructions in documentation
Description
I encountered an issue with the development setup instructions in both CONTRIBUTING.md and README.md. The current instructions use
uv add -e ".[dev]", which fails with the following error:This happens because
uv adddoesn't support the-eflag for editable installs, making it impossible for new contributors to set up their development environment following the current instructions.Changes Made
uv add -e ".[dev]"touv sync --extra devHow I Fixed It
I researched the correct uv command for installing a project with extra dependencies in editable mode. According to the official uv documentation,
uv sync --extra devis the proper command to install a project with its development dependencies. The sync command automatically installs the project in editable mode by default, which is exactly what we need for development.Verification Steps
To verify this fix works correctly:
Clone the repository:
git clone https://github.com/tadata-org/fastapi_mcp.git cd fastapi-mcpCreate a virtual environment with uv:
Try the new command to install development dependencies:
Verify the installation was successful by checking the installed packages:
Further verify that the development environment is working by running the project's development tools:
uv run mypy . uv run pytestAll tools run successfully, confirming the development dependencies were properly installed.
Verify that the examples run correctly:
The example application starts successfully, confirming that the main package and its dependencies are properly installed and functioning.
For comparison, if you try the old command:
uv add -e ".[dev]"You'll see the error mentioned above, demonstrating why this documentation update is necessary.
Related Issues
Fixes #20