Skip to content

Commit baad78a

Browse files
fix: convert all README links to absolute URLs for PyPI compatibility
All relative links to docs, recipes, community files, and config files now point to full GitHub URLs. Also adds cache-buster to PyPI badge. Bump version to 0.1.3.
1 parent caa0b83 commit baad78a

File tree

3 files changed

+42
-35
lines changed

3 files changed

+42
-35
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.1.3] — 2026-03-25
11+
12+
### Fixed
13+
14+
- All README links converted to absolute GitHub URLs so they work on PyPI.
15+
- PyPI badge cache-buster to force fresh render on GitHub.
16+
1017
## [0.1.2] — 2026-03-25
1118

1219
### Fixed

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Production-minded Python components and recipes (cookbook) by Inference Stack.
88

99
[![CI](https://github.com/inference-stack-llc/electripy-studio/actions/workflows/ci.yml/badge.svg)](https://github.com/inference-stack-llc/electripy-studio/actions/workflows/ci.yml)
10-
[![PyPI](https://img.shields.io/pypi/v/electripy-studio?color=brightgreen)](https://pypi.org/project/electripy-studio/)
10+
[![PyPI](https://img.shields.io/pypi/v/electripy-studio?color=brightgreen&v=2)](https://pypi.org/project/electripy-studio/)
1111
[![Release](https://img.shields.io/github/v/release/inference-stack-llc/electripy-studio?label=release&color=brightgreen)](https://github.com/inference-stack-llc/electripy-studio/releases/latest)
1212
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
1313
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -136,7 +136,7 @@ electripy rag eval --corpus data/corpus.jsonl --queries data/queries.jsonl \
136136
--top-k 3,5,10 --report-json out/report.json
137137
```
138138

139-
- LLM Gateway usage (offline-friendly fake provider example): see [recipes/02_llm_gateway/](recipes/02_llm_gateway/).
139+
- LLM Gateway usage (offline-friendly fake provider example): see [recipes/02_llm_gateway/](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes/02_llm_gateway/).
140140

141141
### Demo: Policy Gateway + Agent Collaboration
142142

@@ -152,27 +152,27 @@ Customise with `--prompt` and `--max-hops`:
152152
electripy demo policy-collab --prompt "Alert user@corp.io about outage" --max-hops 6
153153
```
154154

155-
See [recipes/03_policy_collaboration/](recipes/03_policy_collaboration/) for the standalone script.
155+
See [recipes/03_policy_collaboration/](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes/03_policy_collaboration/) for the standalone script.
156156

157157
## Documentation
158158

159-
Full documentation is available in the [docs/](docs/) directory:
160-
161-
- [Installation Guide](docs/getting-started/installation.md)
162-
- [Quickstart](docs/getting-started/quickstart.md)
163-
- [Core Concepts](docs/user-guide/core.md)
164-
- [Concurrency & Resilience](docs/user-guide/concurrency.md)
165-
- [I/O Utilities](docs/user-guide/io.md)
166-
- [CLI Guide](docs/user-guide/cli.md)
167-
- [LLM Gateway & AI](docs/user-guide/ai-llm-gateway.md)
168-
- [AI Telemetry](docs/user-guide/ai-telemetry.md)
169-
- [AI Policy Gateway](docs/user-guide/ai-policy-gateway.md)
170-
- [AI Agent Collaboration Runtime](docs/user-guide/ai-agent-collaboration.md)
171-
- [RAG Evaluation Runner](docs/user-guide/ai-rag-eval-runner.md)
172-
- [AI Product Engineering Utilities](docs/user-guide/ai-product-engineering.md)
173-
- [Component Maturity Model](docs/user-guide/component-maturity.md)
174-
- [Recipes](docs/recipes/cli-tool.md)
175-
- [API Reference](docs/api.md)
159+
Full documentation is available in the [docs/](https://github.com/inference-stack-llc/electripy-studio/tree/main/docs) directory:
160+
161+
- [Installation Guide](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/getting-started/installation.md)
162+
- [Quickstart](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/getting-started/quickstart.md)
163+
- [Core Concepts](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/core.md)
164+
- [Concurrency & Resilience](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/concurrency.md)
165+
- [I/O Utilities](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/io.md)
166+
- [CLI Guide](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/cli.md)
167+
- [LLM Gateway & AI](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-llm-gateway.md)
168+
- [AI Telemetry](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-telemetry.md)
169+
- [AI Policy Gateway](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-policy-gateway.md)
170+
- [AI Agent Collaboration Runtime](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-agent-collaboration.md)
171+
- [RAG Evaluation Runner](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-rag-eval-runner.md)
172+
- [AI Product Engineering Utilities](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/ai-product-engineering.md)
173+
- [Component Maturity Model](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/user-guide/component-maturity.md)
174+
- [Recipes](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/cli-tool.md)
175+
- [API Reference](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/api.md)
176176

177177
Build and serve docs locally:
178178

@@ -301,7 +301,7 @@ The library itself has no dependency on Poetry; it's just a convenient project m
301301

302302
#### 4. pre-commit (for contributors)
303303

304-
Once `pre-commit` is installed, enable the hooks defined in [.pre-commit-config.yaml](.pre-commit-config.yaml):
304+
Once `pre-commit` is installed, enable the hooks defined in [.pre-commit-config.yaml](https://github.com/inference-stack-llc/electripy-studio/blob/main/.pre-commit-config.yaml):
305305

306306
```bash
307307
pre-commit install
@@ -311,23 +311,23 @@ This will automatically run Black, Ruff, and basic whitespace checks on changed
311311

312312
### CI/CD
313313

314-
GitHub Actions automatically runs tests, linting, and type checking on all pull requests. See [.github/workflows/ci.yml](.github/workflows/ci.yml).
314+
GitHub Actions automatically runs tests, linting, and type checking on all pull requests. See [.github/workflows/ci.yml](https://github.com/inference-stack-llc/electripy-studio/blob/main/.github/workflows/ci.yml).
315315

316316
## Recipes
317317

318-
Check out the [recipes/](recipes/) directory for complete examples:
318+
Check out the [recipes/](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes) directory for complete examples:
319319

320-
- [01_cli_tool](recipes/01_cli_tool/) — Building a production-ready CLI tool
321-
- [02_llm_gateway](recipes/02_llm_gateway/) — LLM Gateway basics using a fake provider (offline-friendly)
322-
- [03_policy_collaboration](recipes/03_policy_collaboration/) — End-to-end policy gateway + LLM hooks + multi-agent collaboration demo
320+
- [01_cli_tool](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes/01_cli_tool/) — Building a production-ready CLI tool
321+
- [02_llm_gateway](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes/02_llm_gateway/) — LLM Gateway basics using a fake provider (offline-friendly)
322+
- [03_policy_collaboration](https://github.com/inference-stack-llc/electripy-studio/tree/main/recipes/03_policy_collaboration/) — End-to-end policy gateway + LLM hooks + multi-agent collaboration demo
323323

324324
Additional recipe guides are available in the docs:
325325

326-
- [Policy Gateway recipe](docs/recipes/policy-gateway.md) — standalone policy evaluation walkthrough
327-
- [Agent Collaboration Runtime recipe](docs/recipes/agent-collaboration-runtime.md) — bounded agent handoff patterns
328-
- [Policy + Collaboration E2E recipe](docs/recipes/policy-collaboration-e2e.md) — full pipeline with telemetry
329-
- [RAG Evaluation Runner recipe](docs/recipes/rag-eval-runner.md) — benchmarking retrieval quality
330-
- [AI Telemetry recipe](docs/recipes/ai-telemetry.md) — wiring observability across components
326+
- [Policy Gateway recipe](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/policy-gateway.md) — standalone policy evaluation walkthrough
327+
- [Agent Collaboration Runtime recipe](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/agent-collaboration-runtime.md) — bounded agent handoff patterns
328+
- [Policy + Collaboration E2E recipe](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/policy-collaboration-e2e.md) — full pipeline with telemetry
329+
- [RAG Evaluation Runner recipe](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/rag-eval-runner.md) — benchmarking retrieval quality
330+
- [AI Telemetry recipe](https://github.com/inference-stack-llc/electripy-studio/blob/main/docs/recipes/ai-telemetry.md) — wiring observability across components
331331

332332
## Requirements
333333

@@ -336,14 +336,14 @@ Additional recipe guides are available in the docs:
336336

337337
## License
338338

339-
MIT License - See [LICENSE](LICENSE) for details.
339+
MIT License - See [LICENSE](https://github.com/inference-stack-llc/electripy-studio/blob/main/LICENSE) for details.
340340

341341
## Contributing
342342

343-
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before submitting PRs. For security issues, see [SECURITY.md](SECURITY.md).
343+
Contributions are welcome! Please read our [Contributing Guide](https://github.com/inference-stack-llc/electripy-studio/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/inference-stack-llc/electripy-studio/blob/main/CODE_OF_CONDUCT.md) before submitting PRs. For security issues, see [SECURITY.md](https://github.com/inference-stack-llc/electripy-studio/blob/main/SECURITY.md).
344344

345345
## Links
346346

347347
- [GitHub Repository](https://github.com/inference-stack-llc/electripy-studio)
348-
- [Documentation](docs/)
348+
- [Documentation](https://github.com/inference-stack-llc/electripy-studio/tree/main/docs)
349349
- [Issue Tracker](https://github.com/inference-stack-llc/electripy-studio/issues)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "electripy-studio"
7-
version = "0.1.2"
7+
version = "0.1.3"
88
description = "Production-grade Python toolkit for AI product engineering — LLM gateway, policy guardrails, RAG eval, agent collaboration, telemetry, and more."
99
readme = "README.md"
1010
requires-python = ">=3.11"

0 commit comments

Comments
 (0)