skillware 0.3.7__tar.gz → 0.3.8__tar.gz

{skillware-0.3.7 → skillware-0.3.8}/MANIFEST.in

@@ -1,3 +1,4 @@
 graft skills
+include examples/README.md
 global-exclude __pycache__
 global-exclude *.py[cod]

{skillware-0.3.7/skillware.egg-info → skillware-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: skillware
-Version: 0.3.7
+Version: 0.3.8
 Summary: A framework for modular, self-contained AI skills.
 Author-email: ARPA Hellenic Logical Systems <skillware-os@arpacorp.net>
 License: MIT License
@@ -79,7 +79,7 @@ Dynamic: license-file
 
 <div align="center">
   <img src="https://img.shields.io/badge/License-MIT-efcefa?style=flat-square" alt="License">
-  <img src="https://img.shields.io/badge/Python-3.11+-bae6fd?style=flat-square" alt="Python Version">
+  <img src="https://img.shields.io/badge/Python-3.10+-bae6fd?style=flat-square" alt="Python Version">
   <a href="https://pypi.org/project/skillware/"><img src="https://img.shields.io/pypi/v/skillware?style=flat-square&color=bbf7d0" alt="PyPI Version"></a>
 </div>
 
@@ -150,6 +150,8 @@ Skillware/
 
 ## Quick Start
 
+Requires **Python 3.10 or newer** (see `requires-python` in `pyproject.toml`).
+
 ### 1. Installation
 
 You can install Skillware directly from PyPI:
@@ -163,9 +165,11 @@ Or for development, clone the repository and install in editable mode:
 ```bash
 git clone https://github.com/arpahls/skillware.git
 cd skillware
-pip install -e .
+pip install -e ".[dev,all]"
 ```
 
+For documentation-only work, `pip install -e ".[dev]"` is enough. Skill and framework contributors should use `[dev,all]` to match CI (see [TESTING.md](docs/TESTING.md)).
+
 > **Note**: Individual skills may have their own dependencies. The `SkillLoader` validates `manifest.yaml` and warns of missing packages (e.g., `requests`, `pandas`) upon loading a skill.
 
 ### 2. Verify your installation
@@ -184,12 +188,22 @@ your PATH — use `python -m skillware list` as a fallback. See
 
 ### 3. Configuration
 
-Create a `.env` file with your API keys (e.g., Google Gemini API Key):
+Copy the environment template and add your keys.
+
+**Unix / macOS:**
+
+```bash
+cp .env.example .env
+```
 
-```ini
-GOOGLE_API_KEY="your_key"
+**Windows (PowerShell):**
+
+```powershell
+Copy-Item .env.example .env
 ```
 
+Edit `.env` with agent keys (for example Gemini) and any keys your skills need. Agent keys power your LLM client; skill keys are declared per skill in the [Skill library](docs/skills/README.md). See [API keys for skills](docs/usage/api_keys.md) for setup, security, and framework variables.
+
 ### 4. Usage Example (Gemini)
 
 This example requires the Google SDK optional extra: `pip install "skillware[gemini]"` (local dev: `pip install -e ".[gemini]"`). See the [Gemini usage guide](docs/usage/gemini.md) for setup details.

{skillware-0.3.7 → skillware-0.3.8}/README.md

@@ -8,7 +8,7 @@
 
 <div align="center">
   <img src="https://img.shields.io/badge/License-MIT-efcefa?style=flat-square" alt="License">
-  <img src="https://img.shields.io/badge/Python-3.11+-bae6fd?style=flat-square" alt="Python Version">
+  <img src="https://img.shields.io/badge/Python-3.10+-bae6fd?style=flat-square" alt="Python Version">
   <a href="https://pypi.org/project/skillware/"><img src="https://img.shields.io/pypi/v/skillware?style=flat-square&color=bbf7d0" alt="PyPI Version"></a>
 </div>
 
@@ -79,6 +79,8 @@ Skillware/
 
 ## Quick Start
 
+Requires **Python 3.10 or newer** (see `requires-python` in `pyproject.toml`).
+
 ### 1. Installation
 
 You can install Skillware directly from PyPI:
@@ -92,9 +94,11 @@ Or for development, clone the repository and install in editable mode:
 ```bash
 git clone https://github.com/arpahls/skillware.git
 cd skillware
-pip install -e .
+pip install -e ".[dev,all]"
 ```
 
+For documentation-only work, `pip install -e ".[dev]"` is enough. Skill and framework contributors should use `[dev,all]` to match CI (see [TESTING.md](docs/TESTING.md)).
+
 > **Note**: Individual skills may have their own dependencies. The `SkillLoader` validates `manifest.yaml` and warns of missing packages (e.g., `requests`, `pandas`) upon loading a skill.
 
 ### 2. Verify your installation
@@ -113,12 +117,22 @@ your PATH — use `python -m skillware list` as a fallback. See
 
 ### 3. Configuration
 
-Create a `.env` file with your API keys (e.g., Google Gemini API Key):
+Copy the environment template and add your keys.
+
+**Unix / macOS:**
+
+```bash
+cp .env.example .env
+```
 
-```ini
-GOOGLE_API_KEY="your_key"
+**Windows (PowerShell):**
+
+```powershell
+Copy-Item .env.example .env
 ```
 
+Edit `.env` with agent keys (for example Gemini) and any keys your skills need. Agent keys power your LLM client; skill keys are declared per skill in the [Skill library](docs/skills/README.md). See [API keys for skills](docs/usage/api_keys.md) for setup, security, and framework variables.
+
 ### 4. Usage Example (Gemini)
 
 This example requires the Google SDK optional extra: `pip install "skillware[gemini]"` (local dev: `pip install -e ".[gemini]"`). See the [Gemini usage guide](docs/usage/gemini.md) for setup details.

skillware-0.3.8/examples/README.md

@@ -0,0 +1,61 @@
+# Skillware Examples Index
+
+> **These are usage examples, not tests.** Runnable provider demos live here; automated tests live in `skills/**/test_skill.py` (bundle) and `tests/` (framework and optional maintainer depth). See [TESTING.md](../docs/TESTING.md).
+
+Runnable examples in this directory show how to load Skillware skills, adapt
+them for a provider, execute local skill logic, and return tool results to an
+agent loop. From the repository root, run `skillware examples` or
+`skillware list --examples` to browse the index in the terminal (see
+[CLI reference](../docs/usage/cli.md)). Provider setup details live in the usage guides:
+
+- [API keys for skills](../docs/usage/api_keys.md)
+- [Gemini](../docs/usage/gemini.md)
+- [Claude](../docs/usage/claude.md)
+- [OpenAI](../docs/usage/openai.md)
+- [DeepSeek](../docs/usage/deepseek.md)
+- [Ollama](../docs/usage/ollama.md)
+- [Agent loops](../docs/usage/agent_loops.md)
+
+Use the package extra shown below when installing from PyPI:
+`pip install "skillware[gemini]"`. For local development, use the same extra
+with editable install: `pip install -e ".[gemini]"`.
+
+## Runnable Scripts
+
+| Script | Skill ID | Provider | Required extra | Required env vars | Description |
+| :--- | :--- | :--- | :--- | :--- | :--- |
+| `mental_coach_demo.py` | `wellness/mental_coach` | Local execute | base install only | None | Demonstrates coaching, crisis escalation, and blocked clinical paths locally. |
+| `build_dataset_demo.py` | `data_engineering/synthetic_generator` | Local execute (Gemini backend) | `[gemini]` | `GOOGLE_API_KEY` | Generates a JSONL synthetic dataset with the synthetic generator skill. |
+| `claude_pdf_form_filler.py` | `office/pdf_form_filler` | Claude | `[claude]`, `[office]` | `ANTHROPIC_API_KEY` | Uses Claude with the PDF form filler skill to map instructions to fields. |
+| `claude_tos_evaluator.py` | `compliance/tos_evaluator` | Claude | `[claude]` | `ANTHROPIC_API_KEY` | Runs a Claude tool loop for website automation policy review. |
+| `claude_issue_resolver.py` | `dev_tools/issue_resolver` | Claude | `[claude]` | `ANTHROPIC_API_KEY`; optional `GITHUB_TOKEN` | Claude loop for GitHub issue analysis; fetches issue data after `prepare` (sample: issue #123). |
+| `claude_wallet_check.py` | `finance/wallet_screening` | Claude | `[claude]` | `ANTHROPIC_API_KEY`, `ETHERSCAN_API_KEY` | Screens an Ethereum wallet and returns the result through a Claude tool loop. |
+| `deepseek_tos_evaluator.py` | `compliance/tos_evaluator` | DeepSeek | `[openai]` | `DEEPSEEK_API_KEY` | Uses the OpenAI-compatible DeepSeek API for terms-of-service evaluation. |
+| `gemini_pdf_form_filler.py` | `office/pdf_form_filler` | Gemini | `[gemini]`, `[office]` | `GOOGLE_API_KEY`, `ANTHROPIC_API_KEY` | Uses Gemini as the agent while the PDF skill calls Anthropic for form filling. |
+| `gemini_tos_evaluator.py` | `compliance/tos_evaluator` | Gemini | `[gemini]` | `GOOGLE_API_KEY` | Runs the terms-of-service evaluator with a Gemini function-calling loop. |
+| `gemini_wallet_check.py` | `finance/wallet_screening` | Gemini | `[gemini]` | `GOOGLE_API_KEY`, `ETHERSCAN_API_KEY` | Screens an Ethereum wallet with Gemini orchestration and Etherscan data. |
+| `gemini_evm_tx_handler.py` | `defi/evm_tx_handler` | Gemini | `[gemini]` | `GOOGLE_API_KEY`; for live swaps also `AGENT_WALLET_PRIVATE_KEY`, `BASE_RPC_URL` or `ETHEREUM_RPC_URL`. Set `EVM_TX_HANDLER_EXAMPLE_DEMO=1` for mocked flow without keys. | Resolve → quote → preview → execute buy flow via Gemini tool loop (or demo mode). |
+| `claude_evm_tx_handler.py` | `defi/evm_tx_handler` | Claude | `[claude]` | `ANTHROPIC_API_KEY`; for live swaps also `AGENT_WALLET_PRIVATE_KEY`, RPC URLs. Demo: `EVM_TX_HANDLER_EXAMPLE_DEMO=1`. | Claude tool loop for structured DeFi intent and optional execute after confirmation. |
+| `mica_claude_flow.py` | `compliance/mica_module` | Claude | `[claude]` | `ANTHROPIC_API_KEY` | Runs a MiCA compliance agent loop through Claude. |
+| `mica_ollama_flow.py` | `compliance/mica_module` | Ollama | No Skillware extra; install `ollama` separately | None | Runs a local Ollama MiCA flow with prompt-mode tool calling. |
+| `mica_rag_flow.py` | `compliance/mica_module` | Gemini | `[gemini]` | `GOOGLE_API_KEY` | Runs the MiCA RAG flow with Gemini. |
+| `ollama_skills_test.py` | `finance/wallet_screening`, `office/pdf_form_filler`, `optimization/prompt_rewriter` | Ollama | `[office]`; install `ollama` separately | `ETHERSCAN_API_KEY`, `ANTHROPIC_API_KEY` | Loads multiple skills and tests prompt-mode tool calling with Ollama. |
+| `ollama_tos_evaluator.py` | `compliance/tos_evaluator` | Ollama | No Skillware extra; install `ollama` separately | None | Runs the terms-of-service evaluator with local Ollama prompt-mode calls. |
+| `openai_tos_evaluator.py` | `compliance/tos_evaluator` | OpenAI | `[openai]` | `OPENAI_API_KEY` | Runs the terms-of-service evaluator with OpenAI function calling. |
+| `pii_guardrail_flow.py` | `compliance/pii_masker` | Local execute | base install only | None | Demonstrates local PII masking before passing text to an external agent. |
+| `prompt_compression_demo.py` | `optimization/prompt_rewriter` | Local execute | base install only | None | Demonstrates prompt compression without a provider loop. |
+| `novelty_extractor_demo.py` | `data_engineering/novelty_extractor` | Local execute | `pip install fastembed numpy` | None | Demonstrates multi-turn corpus distillation using local embeddings with no API key. |
+| `gemini_novelty_extractor.py` | `data_engineering/novelty_extractor` | Gemini | `[gemini]`, `pip install fastembed numpy` | `GOOGLE_API_KEY` | Runs the novelty extractor with a Gemini function-calling loop. |
+| `ollama_novelty_extractor.py` | `data_engineering/novelty_extractor` | Ollama | `pip install fastembed numpy`; install `ollama` separately | None | Runs the novelty extractor with local Ollama prompt-mode calls. |
+| `gemini_issue_resolver.py` | `dev_tools/issue_resolver` | Gemini | `[gemini]` | `GOOGLE_API_KEY`; optional `GITHUB_TOKEN` | Gemini loop for GitHub issue analysis; fetches issue data after `prepare` (sample: issue #123). |
+| `ollama_issue_resolver.py` | `dev_tools/issue_resolver` | Ollama | No Skillware extra; install `ollama` separately | optional `GITHUB_TOKEN`; `OLLAMA_MODEL` (default `gemma4:e2b`) | Ollama prompt-mode loop for GitHub issue analysis (sample: issue #123). |
+
+## Notes
+
+- Agent-side model keys such as `GOOGLE_API_KEY`, `ANTHROPIC_API_KEY`,
+  `OPENAI_API_KEY`, and `DEEPSEEK_API_KEY` are documented in the provider
+  guides.
+- Skill runtime keys such as `ETHERSCAN_API_KEY` are documented in each skill
+  manifest and on the skill catalog pages.
+- Ollama examples require the Python `ollama` package, a local Ollama server,
+  and the model named in the script, but no cloud API key.

{skillware-0.3.7 → skillware-0.3.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "skillware"
-version = "0.3.7"
+version = "0.3.8"
 description = "A framework for modular, self-contained AI skills."
 readme = "README.md"
 authors = [