Document uv one-liner for convenient tool usage with installation instructions #8
Conversation
|
@KoblerS 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: KoblerS <32038731+KoblerS@users.noreply.github.com>
README.md
Outdated
| ### Direct usage with uv (no installation needed) | ||
|
|
||
| ```bash | ||
| uv tool run --from python-webflow-exporter webexp --url https://example.webflow.io |
There was a problem hiding this comment.
@copilot this seems to be redundant
There was a problem hiding this comment.
You're right, that was redundant. I've removed the duplicate "Direct usage with uv" section since the command is already shown in the installation section. Changes in commit 9dc383d.
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for using uv as an alternative installation and execution method for the python-webflow-exporter tool. The change provides users with a convenient one-liner option that doesn't require managing virtual environments or performing traditional installation steps.
- Restructures installation documentation to present two options: pip installation and direct uv execution
- Adds corresponding usage examples for both installation methods
- Emphasizes uv's advantage for one-time use scenarios
…redundant usage section Co-authored-by: KoblerS <32038731+KoblerS@users.noreply.github.com>
This PR adds documentation for using
uvto run the python-webflow-exporter tool directly without needing to manage virtual environments or perform a 2-step installation process.Changes Made
Installation Section:
Usage Section:
The uv One-Liner
This command allows users to run the tool immediately without any setup, making it perfect for occasional use or trying out the tool. The
uvtool manager automatically handles downloading dependencies and running the command in an isolated environment.Fixes #4.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.