agentskills-runtime 0.0.1__tar.gz

agentskills_runtime-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenCangJie Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

agentskills_runtime-0.0.1/PKG-INFO

@@ -0,0 +1,454 @@
+Metadata-Version: 2.1
+Name: agentskills-runtime
+Version: 0.0.1
+Summary: Python SDK for AgentSkills Runtime - Install, manage, and execute AI agent skills with built-in runtime support
+Author-email: OpenCangJie Team <team@opencangjie.org>
+Maintainer-email: OpenCangJie Team <team@opencangjie.org>
+License: MIT
+Project-URL: Homepage, https://atomgit.com/uctoo/agentskills-runtime
+Project-URL: Documentation, https://atomgit.com/uctoo/agentskills-runtime#readme
+Project-URL: Repository, https://atomgit.com/uctoo/agentskills-runtime.git
+Project-URL: Issues, https://atomgit.com/uctoo/agentskills-runtime/issues
+Project-URL: Changelog, https://atomgit.com/uctoo/agentskills-runtime/blob/main/CHANGELOG.md
+Keywords: agentskills-runtime,skills,ai,agent,runtime,cli,uctoo,cangjiemagic,mcp,llm-tools,skill-runtime,ai-agent-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: packaging>=21.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build>=1.0.0; extra == "publish"
+Requires-Dist: twine>=4.0.0; extra == "publish"
+
+# agentskills-runtime
+
+Python SDK for AgentSkills Runtime - Install, manage, and execute AI agent skills with built-in runtime support.
+
+## Features
+
+- **Complete Runtime Management**: Download, install, start, and stop the AgentSkills runtime
+- **Skill Management**: Install, list, execute, and remove skills
+- **CLI & Programmatic API**: Use via command line or integrate into your applications
+- **Cross-Platform**: Supports Windows, macOS, and Linux
+- **Type Hints**: Full type annotations for better IDE support
+
+## Installation
+
+```bash
+pip install agentskills-runtime
+```
+
+## Quick Start
+
+### 1. Install the Runtime
+
+```bash
+# Download and install the AgentSkills runtime
+skills install-runtime
+
+# Or specify a version
+skills install-runtime --runtime-version 0.0.13
+```
+
+### 2. Start the Runtime
+
+```bash
+# Start in background (default)
+skills start
+
+# Start in foreground
+skills start --foreground
+
+# Custom port and host
+skills start --port 3000 --host 0.0.0.0
+```
+
+### 3. Manage Skills
+
+```bash
+# Find and install skills
+skills find react
+skills add ./my-skill
+
+# List installed skills
+skills list
+
+# Execute a skill
+skills run my-skill -p '{"input": "data"}'
+```
+
+## CLI Commands
+
+### Runtime Management
+
+#### `skills install-runtime`
+
+Download and install the AgentSkills runtime binary.
+
+```bash
+skills install-runtime
+skills install-runtime --runtime-version 0.0.13
+```
+
+#### `skills start`
+
+Start the AgentSkills runtime server.
+
+```bash
+# Start in background (default)
+skills start
+
+# Start in foreground
+skills start --foreground
+
+# Custom configuration
+skills start --port 3000 --host 0.0.0.0
+```
+
+**Options:**
+- `-p, --port <port>` - Port to listen on (default: 8080)
+- `-h, --host <host>` - Host to bind to (default: 127.0.0.1)
+- `-f, --foreground` - Run in foreground (default: background)
+
+#### `skills stop`
+
+Stop the AgentSkills runtime server.
+
+```bash
+skills stop
+```
+
+#### `skills status`
+
+Check the status of the skills runtime server.
+
+```bash
+skills status
+```
+
+### Skill Management
+
+#### `skills find [query]`
+
+Search for skills interactively or by keyword.
+
+```bash
+skills find
+skills find react testing
+skills find "pdf generation"
+skills find skill --source github --limit 10
+skills find skill --source atomgit --limit 5
+```
+
+**Options:**
+- `-l, --limit <number>`: Maximum number of results, default 10
+- `-s, --source <source>`: Search source, options: `all` (default), `github`, `gitee`, `atomgit`
+
+**Note:** AtomGit search requires setting the `ATOMGIT_TOKEN` environment variable in the runtime's `.env` configuration file.
+
+#### `skills add <source>`
+
+Install a skill from GitHub or local path.
+
+```bash
+skills add ./my-skill
+skills add github.com/user/skill-repo
+skills add github.com/user/skill-repo --branch develop
+```
+
+**Options:**
+- `-g, --global`: Install globally (user-level)
+- `-p, --path <path>`: Local path to skill
+- `-b, --branch <branch>`: Git branch name
+- `-t, --tag <tag>`: Git tag name
+- `-c, --commit <commit>`: Git commit ID
+- `-n, --name <name>`: Skill name override
+- `--validate/--no-validate`: Validate skill before installation (default: True)
+- `-y, --yes`: Skip confirmation prompts
+
+#### `skills list`
+
+List installed skills.
+
+```bash
+skills list
+skills list --limit 50 --page 1
+skills list --json
+```
+
+**Options:**
+- `-l, --limit <number>`: Maximum number of results, default 20
+- `-p, --page <number>`: Page number, default 0
+- `--json`: Output as JSON
+
+#### `skills run <skillId>`
+
+Execute a skill.
+
+```bash
+skills run my-skill -p '{"param1": "value"}'
+skills run my-skill --tool tool-name -p '{"param1": "value"}'
+skills run my-skill -i  # Interactive mode
+```
+
+**Options:**
+- `-t, --tool <name>`: Tool name to execute
+- `-p, --params <json>`: Parameters as JSON string
+- `-f, --params-file <file>`: Parameters from JSON file
+- `-i, --interactive`: Interactive parameter input
+
+#### `skills remove <skillId>`
+
+Remove an installed skill.
+
+```bash
+skills remove my-skill
+skills rm my-skill -y
+```
+
+**Options:**
+- `-y, --yes`: Skip confirmation prompt
+
+#### `skills info <skillId>`
+
+Show detailed information about a skill.
+
+```bash
+skills info my-skill
+```
+
+#### `skills init [name]`
+
+Initialize a new skill project.
+
+```bash
+skills init my-new-skill
+skills init my-new-skill --directory ./skills
+```
+
+**Options:**
+- `-d, --directory <dir>`: Target directory, default: current directory
+- `-t, --template <template>`: Skill template, default: basic
+
+#### `skills check`
+
+Check for skill updates.
+
+```bash
+skills check
+```
+
+## Programmatic API
+
+### Basic Usage
+
+```python
+from agent_skills import SkillsClient, create_client
+
+# Create a client
+client = create_client()
+
+# List skills
+result = client.list_skills(limit=10)
+for skill in result.skills:
+    print(f"{skill.name}: {skill.description}")
+
+# Execute a skill
+result = client.execute_skill("my-skill", {"input": "data"})
+if result.success:
+    print(result.output)
+else:
+    print(f"Error: {result.error_message}")
+```
+
+### Runtime Management
+
+```python
+from agent_skills import RuntimeManager, RuntimeOptions
+
+manager = RuntimeManager()
+
+# Check if runtime is installed
+if not manager.is_installed():
+    # Download and install runtime
+    manager.download_runtime("0.0.13")
+
+# Start runtime
+options = RuntimeOptions(port=8080, host="127.0.0.1")
+process = manager.start(options)
+
+# Check status
+status = manager.status()
+print(f"Running: {status.running}, Version: {status.version}")
+
+# Stop runtime
+manager.stop()
+```
+
+### Skill Definition
+
+```python
+from agent_skills import define_skill, SkillMetadata, ToolDefinition, ToolParameter, ParamType
+
+# Define a skill
+skill = define_skill(
+    metadata=SkillMetadata(
+        name="my-skill",
+        version="1.0.0",
+        description="My custom skill",
+        author="Your Name",
+    ),
+    tools=[
+        ToolDefinition(
+            name="my-tool",
+            description="A tool that does something",
+            parameters=[
+                ToolParameter(
+                    name="input",
+                    param_type=ParamType.STRING,
+                    description="Input parameter",
+                    required=True,
+                ),
+            ],
+        ),
+    ],
+)
+```
+
+### Configuration
+
+```python
+from agent_skills import get_config
+
+# Get configuration from environment variables prefixed with SKILL_
+config = get_config()
+api_key = config.get("API_KEY")  # From SKILL_API_KEY env var
+```
+
+## Configuration
+
+### Environment Variables
+
+- `SKILL_RUNTIME_API_URL`: API server URL (default: http://127.0.0.1:8080)
+- `SKILL_INSTALL_PATH`: Default path for skill installation
+- `SKILL_*`: Custom configuration accessible via `get_config()`
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://atomgit.com/uctoo/agentskills-runtime.git
+cd agentskills-runtime/sdk/python
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install development dependencies
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=agent_skills
+
+# Run specific test file
+pytest tests/test_models.py
+```
+
+### Code Quality
+
+```bash
+# Format code
+black src tests
+
+# Sort imports
+isort src tests
+
+# Type check
+mypy src
+
+# Lint
+ruff check src tests
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Publishing to PyPI
+
+### Prerequisites
+
+1. Create an account on [PyPI](https://pypi.org/account/register/)
+2. Generate an API token from [PyPI Account Settings](https://pypi.org/manage/account/token/)
+3. Update `.pypirc` with your token:
+
+```ini
+[pypi]
+username = __token__
+password = pypi-xxxx...  # Your PyPI API token
+```
+
+### Publish to PyPI
+
+```bash
+# Install publish dependencies
+pip install -e ".[publish]"
+
+# Method 1: Using the publish script
+python publish.py
+
+# Method 2: Manual publish
+python -m build
+python -m twine upload dist/*
+
+# Publish to TestPyPI first (recommended for testing)
+python publish.py --test
+```
+
+### Important Notes
+
+- **Never commit `.pypirc` with real tokens to version control**
+- The `.gitignore` file excludes `.pypirc` by default
+- Use TestPyPI for testing before publishing to production PyPI
+- Version numbers must be unique for each publish
+
+## Links
+
+- [Documentation](https://atomgit.com/uctoo/agentskills-runtime#readme)
+- [Repository](https://atomgit.com/uctoo/agentskills-runtime)
+- [Issue Tracker](https://atomgit.com/uctoo/agentskills-runtime/issues)
+- [JavaScript SDK](../javascript)