TacitLab/coinhunter-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: recommend pipx for end-user installation to avoid externally-managed-environment errors

Browse Source 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Tacit Lab
2026-04-16 01:37:31 +08:00
parent 72f5bbcbb7
commit 3819e35a7b
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CLAUDE.md
View File

@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- **Editable install:** `pip install -e .` - **Editable install:** `pip install -e .`
- **Run the CLI locally:** `python -m coinhunter --help` - **Run the CLI locally:** `python -m coinhunter --help`
- **Install for end users:** `./scripts/install_local.sh` (standard `pip install -e .` wrapper) - **Install for end users:** `pipx install coinhunter` (recommended) or `./scripts/install_local.sh` for local editable install.
- **Tests:** There is no test suite yet. The README lists next priorities as adding pytest coverage for runtime paths, state manager, and trigger analyzer. - **Tests:** There is no test suite yet. The README lists next priorities as adding pytest coverage for runtime paths, state manager, and trigger analyzer.
- **Lint / type-check:** Not configured yet. - **Lint / type-check:** Not configured yet.

6
README.md
View File

@@ -89,8 +89,10 @@ src/coinhunter/
### From PyPI (recommended) ### From PyPI (recommended)
`coinhunter` is a standalone CLI application. Use [pipx](https://pypa.github.io/pipx/) to install it in an isolated environment:
```bash ```bash
pip install coinhunter pipx install coinhunter
``` ```
This installs the latest stable release and creates the `coinhunter` console script entry point. This installs the latest stable release and creates the `coinhunter` console script entry point.
@@ -102,6 +104,8 @@ coinhunter --help
coinhunter --version coinhunter --version
``` ```
> On newer Linux distributions, installing directly into the system Python with `pip install coinhunter` will fail with `externally-managed-environment`. Use `pipx` or a virtual environment instead.
### Development install (editable) ### Development install (editable)
If you're working on this repo locally: If you're working on this repo locally: