Skip to content

docs: fix provider registry path #30

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

Open
CooperSheroy wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −9
Open

docs: fix provider registry path #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Create and activate a virtual environment first (all `make` targets assume the v

```bash
# Clone the repository
git clone https://github.com/NVIDIA/skillspector.git
cd skillspector
git clone https://github.com/NVIDIA/SkillSpector.git
cd SkillSpector

# Create and activate virtual environment
uv venv .venv && source .venv/bin/activate
Expand Down Expand Up @@ -344,7 +344,7 @@ Issues (2)
| `OPENAI_BASE_URL` | Override the OpenAI endpoint (e.g. point at Ollama). | Optional |
| `ANTHROPIC_API_KEY` | Credential for the Anthropic provider (`SKILLSPECTOR_PROVIDER=anthropic`). | Required for LLM analysis when `SKILLSPECTOR_PROVIDER=anthropic` |
| `SKILLSPECTOR_MODEL` | Override the active provider's default model. See the LLM Analysis table for each provider's default. | Optional |
| `SKILLSPECTOR_MODEL_REGISTRY` | Override the bundled per-provider YAML registry (`src/skillspector/providers/<provider>.yaml`) with a custom path. | Optional |
| `SKILLSPECTOR_MODEL_REGISTRY` | Override the bundled per-provider YAML registry (`src/skillspector/providers/<provider>/model_registry.yaml`) with a custom path. | Optional |
| `SKILLSPECTOR_LOG_LEVEL` | Log level: `DEBUG`, `INFO`, `WARNING`, `ERROR` (default: `WARNING`). | Optional |

### CLI Options
Expand All @@ -368,8 +368,8 @@ All `make` targets assume a virtual environment is already created and activated

```bash
# Clone, create venv, activate, install dev dependencies
git clone https://github.com/NVIDIA/skillspector.git
cd skillspector
git clone https://github.com/NVIDIA/SkillSpector.git
cd SkillSpector
uv venv .venv && source .venv/bin/activate
# or: python3 -m venv .venv && source .venv/bin/activate
make install-dev
Expand Down Expand Up @@ -466,4 +466,4 @@ Contributions are welcome! Please read our contributing guidelines and submit pu

## Support

- **Issues**: [GitHub Issues](https://github.com/NVIDIA/skillspector/issues)
- **Issues**: [GitHub Issues](https://github.com/NVIDIA/SkillSpector/issues)
6 changes: 3 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ dev = [
skillspector = "skillspector.cli:app"

[project.urls]
Homepage = "https://github.com/NVIDIA/skillspector"
Documentation = "https://github.com/NVIDIA/skillspector#readme"
Issues = "https://github.com/NVIDIA/skillspector/issues"
Homepage = "https://github.com/NVIDIA/SkillSpector"
Documentation = "https://github.com/NVIDIA/SkillSpector#readme"
Issues = "https://github.com/NVIDIA/SkillSpector/issues"

[tool.hatch.build]
exclude = [".claude/", ".cursor/", ".agents/"]
Expand Down