-
Notifications
You must be signed in to change notification settings - Fork 3
docs(contrib): streamline contributor workflow and add issue-first approach #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # Python Dependency Manager Companion MCP Server | ||
|
|
||
| > README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe) | ||
KemingHe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Official docs from `pip`, `poetry`, `uv`, and `conda` + automated weekly updates = zero maintenance overhead for developers using VSCode/Cursor with AI assistants. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a) | ||
|
|
||
| ## 🚀 Quick Start for Agentic IDEs | ||
|
|
||
| **1. Pull latest Docker image**: | ||
|
|
||
| ```shell | ||
| docker pull keminghe/py-dep-man-companion:latest | ||
| ``` | ||
|
|
||
| **2. Add to your IDE's `mcp.json`**: | ||
|
|
||
| ```json | ||
| { | ||
| "mcp": { | ||
| "servers": { | ||
| "python-deps": { | ||
| "command": "docker", | ||
| "args": ["run", "-i", "--rm", "keminghe/py-dep-man-companion:latest"] | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| **3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates. | ||
|
|
||
| ## 🔄 Auto-Update Architecture | ||
|
|
||
| ```plaintext | ||
| ┌───────────────────────────┐ | ||
| │ ⏰ Every Tuesday 6pm ET │ | ||
| └─────────────┬─────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────┐ | ||
| │ 📚 Sync Official Docs │ | ||
| └─────────────┬─────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────┐ | ||
| │ 🔍 Rebuild Search Index │ | ||
| └─────────────┬─────────────┘ | ||
| ▼ | ||
| ┌───────────────────────────┐ | ||
| │ 🐳 Publish Latest Image │ | ||
| └───────────────────────────┘ | ||
| ``` | ||
|
|
||
| **Zero maintenance**: Documentation automatically synced weekly from official sources. Docker `:latest` tag guarantees you always get current docs without manual updates. | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| **Use as template**: [[Create from template]](https://github.com/new?template_name=python-dependency-manager-companion-mcp-server&template_owner=KemingHe) for your own MCP server projects. | ||
|
|
||
| **Contribute back**: Fork and follow [CONTRIBUTING.md](https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/blob/main/CONTRIBUTING.md) for development setup. | ||
|
|
||
| ## 🗺️ Roadmap | ||
|
|
||
| - [ ] Add support for `pipenv`, `pdm`, `pixi` | ||
| - [ ] Add comprehensive tests with 100% coverage | ||
| - [ ] Add indexing support for PDF and CSV files | ||
|
|
||
| ## 📄 License | ||
|
|
||
| This project is licensed under the [MIT License](https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/blob/main/LICENSE) - a permissive license that allows free use, modification, and distribution with attribution. | ||
|
|
||
| ## 📞 Support | ||
|
|
||
| Open a [GitHub issue](https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/issues) for bug reports and feature requests. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Uh oh!
There was an error while loading. Please reload this page.