Skip to content

docs(readme): improve clarity and add security guidance #6

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.

Sign up for GitHub

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 5 commits into from
Jul 24, 2025
Merged

docs(readme): improve clarity and add security guidance #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07ba766
docs(readme): improve clarity and add security guidance
KemingHe Jul 24, 2025
14b0d70
docs(README*.md): add concrete example to pin image to commit hash
KemingHe Jul 24, 2025
445a0d6
fix(README*.md): correct docker image commit hash tag format
KemingHe Jul 24, 2025
e6def25
docs(REAME*.md): remove excess whitespace
KemingHe Jul 24, 2025
8a4a3b2
docs(README*.md): add action-oriented comments for docker pull
KemingHe Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 12 additions & 22 deletions README-dockerhub.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

> README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe)

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)
Stop getting out-of-date Python package manager commands from your AI. Cross-reference latest official `pip`, `poetry`, `uv`, and `conda` docs with auto-updates. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)

## 🚀 Quick Start for Agentic IDEs

**1. Pull latest Docker image**:
**1. Pull Docker image**:

```shell
# Pin to commit hash for production security
# Get current hash from: https://hub.docker.com/r/keminghe/py-dep-man-companion/tags
docker pull keminghe/py-dep-man-companion@sha256:2c896dc617e8cd3b1a1956580322b0f0c80d5b6dfd09743d90859d2ef2b71ec6 # 2025-07-22 release example

# Or use latest for development
docker pull keminghe/py-dep-man-companion:latest
```

Expand All @@ -27,29 +32,14 @@ docker pull keminghe/py-dep-man-companion:latest
}
```

**3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates.
**3. Ask package manager questions** - "How to migrate a `conda` project to `uv`?" and get accurate, current official syntax.

## 🔄 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.
1. ⏰ **Every Tuesday 6pm ET**
2. 📚 **Sync Official Docs**
3. 🔍 **Rebuild Search Index**
4. 🐳 **Publish Latest Image**

## 🤝 Contributing

Expand Down
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

> README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe)

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)
Stop getting out-of-date Python package manager commands from your AI. Cross-reference latest official `pip`, `poetry`, `uv`, and `conda` docs with auto-updates. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)

## 🚀 Quick Start for Agentic IDEs

**1. Pull latest Docker image**:
**1. Pull Docker image**:

```shell
# Pin to commit hash for production security
# Get current hash from: https://hub.docker.com/r/keminghe/py-dep-man-companion/tags
docker pull keminghe/py-dep-man-companion@sha256:2c896dc617e8cd3b1a1956580322b0f0c80d5b6dfd09743d90859d2ef2b71ec6 # 2025-07-22 release example

# Or use latest for development
docker pull keminghe/py-dep-man-companion:latest
```

Expand All @@ -27,7 +32,7 @@ docker pull keminghe/py-dep-man-companion:latest
}
```

**3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates.
**3. Ask package manager questions** - "How to migrate a `conda` project to `uv`?" and get accurate, current official syntax.

## 🤝 Contributing

Expand All @@ -49,8 +54,6 @@ graph LR
INDEX --> DOCKER
```

**Zero maintenance**: Documentation automatically synced weekly from official sources. Docker `:latest` tag guarantees you always get current docs without manual updates.

## 🗺️ Roadmap

- [ ] Add support for `pipenv`, `pdm`, `pixi`
Expand Down