evalrun 0.4.0__tar.gz → 0.4.1__tar.gz

{evalrun-0.4.0/evalrun.egg-info → evalrun-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evalrun
-Version: 0.4.0
+Version: 0.4.1
 Summary: Provider-agnostic evaluation and regression-testing toolkit for tool-using AI agents.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -43,6 +43,17 @@ The toolkit works with hosted APIs and models running on your own computer. It d
 
 ### 1. Installation
 
+Install the released package from PyPI:
+
+```bash
+python -m pip install evalrun
+```
+
+The package installs the `evalrun` command and all runtime dependencies. You do
+not need to clone this repository to use the toolkit. To contribute or run the
+latest unreleased source instead, clone the repository and use an editable
+install:
+
 ```bash
 git clone https://github.com/imshivamb/agent-eval-platform.git
 cd agent-eval-platform
@@ -138,7 +149,7 @@ Open `http://127.0.0.1:8501` in your browser to configure endpoints, select scen
 Integrate `evalrun` programmatically into Python automation pipelines:
 
 ```python
-from framework.sdk import evaluate, compare
+from framework import evaluate, compare
 
 # 1. Execute Benchmark Evaluation
 results = evaluate(
@@ -192,13 +203,26 @@ There is no central service to deploy for the current product. The recommended p
 
 1. Publish the repository on GitHub.
 2. Add tagged releases and a clear quick-start guide.
-3. Users install it locally with `pip install -e .` from a clone.
-4. Later publish the package to PyPI so users can run `pip install evalrun`.
+3. Users install the released package with `pip install evalrun`.
+4. Contributors install the repository with `pip install -e .` when working on source changes.
 5. Host documentation on GitHub Pages if useful; the evaluation engine itself remains local.
 6. Users provide their own hosted-model API keys or run their own local model server.
 
 The local UI is intended for local use, not public internet deployment. A shared hosted deployment would be a separate project requiring authentication, secret management, isolation, and hosted execution.
 
+### TestPyPI (maintainers only)
+
+Before a release, maintainers may validate a candidate package from TestPyPI:
+
+```bash
+python -m pip install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  evalrun
+```
+
+End users should use the normal PyPI install shown above.
+
 ### Credential promise
 
 EvalRun does not provide, collect, or store model credentials. A key is read by the local process and passed to the selected model endpoint for that run. Keys are never written to `manifest.json`, `report.html`, or `regression_report.json`; reports contain only `[REDACTED]`. Prefer environment variables such as `OPENAI_API_KEY`, `GEMINI_API_KEY`, or `OPENROUTER_API_KEY`. Avoid putting real keys directly in shell commands because your terminal may save command history.

{evalrun-0.4.0 → evalrun-0.4.1}/README.md

@@ -27,6 +27,17 @@ The toolkit works with hosted APIs and models running on your own computer. It d
 
 ### 1. Installation
 
+Install the released package from PyPI:
+
+```bash
+python -m pip install evalrun
+```
+
+The package installs the `evalrun` command and all runtime dependencies. You do
+not need to clone this repository to use the toolkit. To contribute or run the
+latest unreleased source instead, clone the repository and use an editable
+install:
+
 ```bash
 git clone https://github.com/imshivamb/agent-eval-platform.git
 cd agent-eval-platform
@@ -122,7 +133,7 @@ Open `http://127.0.0.1:8501` in your browser to configure endpoints, select scen
 Integrate `evalrun` programmatically into Python automation pipelines:
 
 ```python
-from framework.sdk import evaluate, compare
+from framework import evaluate, compare
 
 # 1. Execute Benchmark Evaluation
 results = evaluate(
@@ -176,13 +187,26 @@ There is no central service to deploy for the current product. The recommended p
 
 1. Publish the repository on GitHub.
 2. Add tagged releases and a clear quick-start guide.
-3. Users install it locally with `pip install -e .` from a clone.
-4. Later publish the package to PyPI so users can run `pip install evalrun`.
+3. Users install the released package with `pip install evalrun`.
+4. Contributors install the repository with `pip install -e .` when working on source changes.
 5. Host documentation on GitHub Pages if useful; the evaluation engine itself remains local.
 6. Users provide their own hosted-model API keys or run their own local model server.
 
 The local UI is intended for local use, not public internet deployment. A shared hosted deployment would be a separate project requiring authentication, secret management, isolation, and hosted execution.
 
+### TestPyPI (maintainers only)
+
+Before a release, maintainers may validate a candidate package from TestPyPI:
+
+```bash
+python -m pip install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  evalrun
+```
+
+End users should use the normal PyPI install shown above.
+
 ### Credential promise
 
 EvalRun does not provide, collect, or store model credentials. A key is read by the local process and passed to the selected model endpoint for that run. Keys are never written to `manifest.json`, `report.html`, or `regression_report.json`; reports contain only `[REDACTED]`. Prefer environment variables such as `OPENAI_API_KEY`, `GEMINI_API_KEY`, or `OPENROUTER_API_KEY`. Avoid putting real keys directly in shell commands because your terminal may save command history.

{evalrun-0.4.0 → evalrun-0.4.1/evalrun.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evalrun
-Version: 0.4.0
+Version: 0.4.1
 Summary: Provider-agnostic evaluation and regression-testing toolkit for tool-using AI agents.
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -43,6 +43,17 @@ The toolkit works with hosted APIs and models running on your own computer. It d
 
 ### 1. Installation
 
+Install the released package from PyPI:
+
+```bash
+python -m pip install evalrun
+```
+
+The package installs the `evalrun` command and all runtime dependencies. You do
+not need to clone this repository to use the toolkit. To contribute or run the
+latest unreleased source instead, clone the repository and use an editable
+install:
+
 ```bash
 git clone https://github.com/imshivamb/agent-eval-platform.git
 cd agent-eval-platform
@@ -138,7 +149,7 @@ Open `http://127.0.0.1:8501` in your browser to configure endpoints, select scen
 Integrate `evalrun` programmatically into Python automation pipelines:
 
 ```python
-from framework.sdk import evaluate, compare
+from framework import evaluate, compare
 
 # 1. Execute Benchmark Evaluation
 results = evaluate(
@@ -192,13 +203,26 @@ There is no central service to deploy for the current product. The recommended p
 
 1. Publish the repository on GitHub.
 2. Add tagged releases and a clear quick-start guide.
-3. Users install it locally with `pip install -e .` from a clone.
-4. Later publish the package to PyPI so users can run `pip install evalrun`.
+3. Users install the released package with `pip install evalrun`.
+4. Contributors install the repository with `pip install -e .` when working on source changes.
 5. Host documentation on GitHub Pages if useful; the evaluation engine itself remains local.
 6. Users provide their own hosted-model API keys or run their own local model server.
 
 The local UI is intended for local use, not public internet deployment. A shared hosted deployment would be a separate project requiring authentication, secret management, isolation, and hosted execution.
 
+### TestPyPI (maintainers only)
+
+Before a release, maintainers may validate a candidate package from TestPyPI:
+
+```bash
+python -m pip install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  evalrun
+```
+
+End users should use the normal PyPI install shown above.
+
 ### Credential promise
 
 EvalRun does not provide, collect, or store model credentials. A key is read by the local process and passed to the selected model endpoint for that run. Keys are never written to `manifest.json`, `report.html`, or `regression_report.json`; reports contain only `[REDACTED]`. Prefer environment variables such as `OPENAI_API_KEY`, `GEMINI_API_KEY`, or `OPENROUTER_API_KEY`. Avoid putting real keys directly in shell commands because your terminal may save command history.

{evalrun-0.4.0 → evalrun-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "evalrun"
-version = "0.4.0"
+version = "0.4.1"
 description = "Provider-agnostic evaluation and regression-testing toolkit for tool-using AI agents."
 readme = "README.md"
 requires-python = ">=3.10"