Skip to content

Conversation

@james-alvey-42
Copy link
Collaborator

Summary

This PR addresses issue #50 by adding comprehensive installation instructions for using uv as an alternative to the standard venv approach.

Changes Made

  • README.md: Added a new "Alternative Installation (uv)" section with complete setup instructions
  • README.md: Updated Requirements section to mention uv as an optional package manager
  • CONTRIBUTING.md: Added uv setup option for contributors alongside the standard venv instructions

Key Features

The new uv installation instructions include:

  • Step-by-step setup using uv sync
  • Optional PATH configuration for global access to MCP tools without environment activation
  • Clear explanations of the benefits of using uv (speed and convenience)
  • Consistent structure matching the existing standard installation instructions

Testing

This is a documentation-only change with no code modifications. The instructions have been verified to:

  • Follow the project's documentation style and format
  • Maintain consistency with existing installation guidelines
  • Provide all necessary information for successful setup

Related Issue

Closes #50

Additional Notes

The uv approach offers users:

  1. Faster package installation and environment management
  2. The ability to call MCP tools from anywhere when .venv/bin is added to PATH
  3. Modern Python tooling that complements existing workflows

The standard venv approach remains the primary installation method, with uv presented as a well-documented alternative for users who prefer it.

🤖 Generated with Claude Code

Add comprehensive installation instructions for using uv as an alternative
to the standard venv approach. This addresses issue #50 by providing:

- Alternative installation section in README.md using uv sync
- Optional PATH setup instructions for global access to MCP tools
- Updated CONTRIBUTING.md with uv setup option for contributors
- Added uv as an optional package manager in Requirements section

The uv approach offers faster installation and the convenience of
accessing MCP tools from anywhere without activating the virtual
environment when the .venv/bin directory is added to PATH.

Fixes #50

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Instructions for uv installation

2 participants