deepctl-plugin-example 0.1.10__tar.gz → 0.1.11__tar.gz

deepctl_plugin_example-0.1.11/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: deepctl-plugin-example
+Version: 0.1.11
+Summary: Example plugin for deepctl
+Author-email: Deepgram <devrel@deepgram.com>
+Maintainer-email: Deepgram <devrel@deepgram.com>
+License-Expression: MIT
+Keywords: deepgram,cli,plugin,example
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: deepctl-core>=0.1.10
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+
+# deepctl-plugin-example
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+Example plugin for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl example` | `deepctl_plugin_example.command:ExampleCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_plugin_example-0.1.11/README.md

@@ -0,0 +1,41 @@
+# deepctl-plugin-example
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+Example plugin for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl example` | `deepctl_plugin_example.command:ExampleCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

{deepctl_plugin_example-0.1.10 → deepctl_plugin_example-0.1.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "deepctl-plugin-example"
-version = "0.1.10"
+version = "0.1.11" # x-release-please-version
 description = "Example plugin for deepctl"
 readme = "README.md"
 license = "MIT"
@@ -20,7 +20,11 @@ classifiers = [
 ]
 keywords = ["deepgram", "cli", "plugin", "example"]
 requires-python = ">=3.10"
-dependencies = ["deepctl-core>=0.1.10", "click>=8.0.0", "rich>=13.0.0"]
+dependencies = [
+    "deepctl-core>=0.1.10",
+    "click>=8.0.0",
+    "rich>=13.0.0",
+]
 
 [project.entry-points."deepctl.plugins"]
 example = "deepctl_plugin_example.command:ExampleCommand"

deepctl_plugin_example-0.1.11/src/deepctl_plugin_example.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: deepctl-plugin-example
+Version: 0.1.11
+Summary: Example plugin for deepctl
+Author-email: Deepgram <devrel@deepgram.com>
+Maintainer-email: Deepgram <devrel@deepgram.com>
+License-Expression: MIT
+Keywords: deepgram,cli,plugin,example
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: deepctl-core>=0.1.10
+Requires-Dist: click>=8.0.0
+Requires-Dist: rich>=13.0.0
+
+# deepctl-plugin-example
+
+> Part of [deepctl](https://github.com/deepgram/cli) — Official Deepgram CLI
+
+Example plugin for deepctl
+
+## Installation
+
+This package is included with deepctl and does not need to be installed separately.
+
+### Install deepctl
+
+```bash
+# Install with pip
+pip install deepctl
+
+# Or install with uv
+uv tool install deepctl
+
+# Or install with pipx
+pipx install deepctl
+
+# Or run without installing
+uvx deepctl --help
+pipx run deepctl --help
+```
+
+## Commands
+
+| Command | Entry Point |
+|---------|-------------|
+| `deepctl example` | `deepctl_plugin_example.command:ExampleCommand` |
+
+## Dependencies
+
+- `click>=8.0.0`
+- `rich>=13.0.0`
+
+## License
+
+MIT — see [LICENSE](../../LICENSE)

deepctl_plugin_example-0.1.10/PKG-INFO

@@ -1,147 +0,0 @@
-Metadata-Version: 2.4
-Name: deepctl-plugin-example
-Version: 0.1.10
-Summary: Example plugin for deepctl
-Author-email: Deepgram <devrel@deepgram.com>
-Maintainer-email: Deepgram <devrel@deepgram.com>
-License-Expression: MIT
-Keywords: deepgram,cli,plugin,example
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: deepctl-core>=0.1.10
-Requires-Dist: click>=8.0.0
-Requires-Dist: rich>=13.0.0
-
-# deepctl Plugin Example
-
-An example plugin for deepctl demonstrating how to create and distribute custom commands as separate packages.
-
-## Overview
-
-This plugin shows how to extend deepctl with custom commands that can be:
-
-- Developed independently
-- Distributed via PyPI
-- Installed alongside the CLI
-- Discovered automatically at runtime
-
-**Note:** This plugin is NOT a dependency of deepctl. It must be installed separately to demonstrate how the plugin system works for third-party developers. This example plugin is published to PyPI with each deepctl release to ensure the documentation is always testable.
-
-## Installation
-
-### Development Installation
-
-To install the plugin in development mode:
-
-```bash
-# From the plugin directory
-pip install -e .
-
-# Or using uv
-uv pip install -e .
-```
-
-### Production Installation
-
-For users who have deepctl installed globally:
-
-```bash
-# Recommended: Using pipx (if deepctl was installed with pipx)
-pipx install deepctl  # If not already installed
-pipx inject deepctl deepctl-plugin-example
-
-# Alternative: Using pip (only works in development environments)
-pip install deepctl deepctl-plugin-example
-```
-
-**Note:** If you installed deepctl with `uv tool install`, plugin installation requires manual workarounds. We recommend using pipx for the best plugin experience.
-
-## Usage
-
-Once installed, the plugin command becomes available in the CLI:
-
-```bash
-# Basic usage
-deepctl example
-
-# Custom greeting
-deepctl example --greeting "Howdy" --name "Partner"
-
-# Show plugin system information
-deepctl example --show-info
-```
-
-## How It Works
-
-1. **Entry Point Registration**: The plugin registers itself via the `deepctl.plugins` entry point in `pyproject.toml`
-2. **Command Discovery**: The CLI's PluginManager discovers the plugin at runtime using `importlib.metadata`
-3. **Command Loading**: The plugin's command class is instantiated and added to the CLI
-4. **Execution**: When the user runs the command, the plugin's `handle()` method is called
-
-## Creating Your Own Plugin
-
-To create your own deepctl plugin:
-
-1. **Copy this example package** as a starting point
-2. **Rename the package** and update metadata in `pyproject.toml`
-3. **Implement your command** by modifying the `command.py` file
-4. **Define arguments** in the `get_arguments()` method
-5. **Implement logic** in the `handle()` method
-6. **Test locally** with `pip install -e .`
-7. **Publish to PyPI** when ready
-8. **Users install it** with `pipx inject deepctl your-plugin-name`
-
-### Key Requirements
-
-- Must inherit from `deepctl_core.BaseCommand`
-- Must implement required properties: `name`, `help`
-- Must implement `handle()` method
-- Must be registered via entry point
-
-### Example Command Structure
-
-```python
-from deepctl_core import BaseCommand
-
-class MyCommand(BaseCommand):
-    name = "mycommand"
-    help = "Description of my command"
-
-    def handle(self, config, auth_manager, client, **kwargs):
-        # Your command logic here
-        pass
-```
-
-## Development
-
-### Running Tests
-
-```bash
-uv run pytest
-```
-
-### Building the Package
-
-```bash
-python -m build
-```
-
-## Plugin Capabilities
-
-Plugins have access to:
-
-- Configuration management via `Config`
-- Authentication via `AuthManager`
-- Deepgram API client via `DeepgramClient`
-- Rich terminal output via `rich`
-- Command-line argument parsing via `click`
-
-## License
-
-MIT

deepctl_plugin_example-0.1.10/README.md

@@ -1,127 +0,0 @@
-# deepctl Plugin Example
-
-An example plugin for deepctl demonstrating how to create and distribute custom commands as separate packages.
-
-## Overview
-
-This plugin shows how to extend deepctl with custom commands that can be:
-
-- Developed independently
-- Distributed via PyPI
-- Installed alongside the CLI
-- Discovered automatically at runtime
-
-**Note:** This plugin is NOT a dependency of deepctl. It must be installed separately to demonstrate how the plugin system works for third-party developers. This example plugin is published to PyPI with each deepctl release to ensure the documentation is always testable.
-
-## Installation
-
-### Development Installation
-
-To install the plugin in development mode:
-
-```bash
-# From the plugin directory
-pip install -e .
-
-# Or using uv
-uv pip install -e .
-```
-
-### Production Installation
-
-For users who have deepctl installed globally:
-
-```bash
-# Recommended: Using pipx (if deepctl was installed with pipx)
-pipx install deepctl  # If not already installed
-pipx inject deepctl deepctl-plugin-example
-
-# Alternative: Using pip (only works in development environments)
-pip install deepctl deepctl-plugin-example
-```
-
-**Note:** If you installed deepctl with `uv tool install`, plugin installation requires manual workarounds. We recommend using pipx for the best plugin experience.
-
-## Usage
-
-Once installed, the plugin command becomes available in the CLI:
-
-```bash
-# Basic usage
-deepctl example
-
-# Custom greeting
-deepctl example --greeting "Howdy" --name "Partner"
-
-# Show plugin system information
-deepctl example --show-info
-```
-
-## How It Works
-
-1. **Entry Point Registration**: The plugin registers itself via the `deepctl.plugins` entry point in `pyproject.toml`
-2. **Command Discovery**: The CLI's PluginManager discovers the plugin at runtime using `importlib.metadata`
-3. **Command Loading**: The plugin's command class is instantiated and added to the CLI
-4. **Execution**: When the user runs the command, the plugin's `handle()` method is called
-
-## Creating Your Own Plugin
-
-To create your own deepctl plugin:
-
-1. **Copy this example package** as a starting point
-2. **Rename the package** and update metadata in `pyproject.toml`
-3. **Implement your command** by modifying the `command.py` file
-4. **Define arguments** in the `get_arguments()` method
-5. **Implement logic** in the `handle()` method
-6. **Test locally** with `pip install -e .`
-7. **Publish to PyPI** when ready
-8. **Users install it** with `pipx inject deepctl your-plugin-name`
-
-### Key Requirements
-
-- Must inherit from `deepctl_core.BaseCommand`
-- Must implement required properties: `name`, `help`
-- Must implement `handle()` method
-- Must be registered via entry point
-
-### Example Command Structure
-
-```python
-from deepctl_core import BaseCommand
-
-class MyCommand(BaseCommand):
-    name = "mycommand"
-    help = "Description of my command"
-
-    def handle(self, config, auth_manager, client, **kwargs):
-        # Your command logic here
-        pass
-```
-
-## Development
-
-### Running Tests
-
-```bash
-uv run pytest
-```
-
-### Building the Package
-
-```bash
-python -m build
-```
-
-## Plugin Capabilities
-
-Plugins have access to:
-
-- Configuration management via `Config`
-- Authentication via `AuthManager`
-- Deepgram API client via `DeepgramClient`
-- Rich terminal output via `rich`
-- Command-line argument parsing via `click`
-
-## License
-
-MIT

deepctl_plugin_example-0.1.10/src/deepctl_plugin_example.egg-info/PKG-INFO

@@ -1,147 +0,0 @@
-Metadata-Version: 2.4
-Name: deepctl-plugin-example
-Version: 0.1.10
-Summary: Example plugin for deepctl
-Author-email: Deepgram <devrel@deepgram.com>
-Maintainer-email: Deepgram <devrel@deepgram.com>
-License-Expression: MIT
-Keywords: deepgram,cli,plugin,example
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: deepctl-core>=0.1.10
-Requires-Dist: click>=8.0.0
-Requires-Dist: rich>=13.0.0
-
-# deepctl Plugin Example
-
-An example plugin for deepctl demonstrating how to create and distribute custom commands as separate packages.
-
-## Overview
-
-This plugin shows how to extend deepctl with custom commands that can be:
-
-- Developed independently
-- Distributed via PyPI
-- Installed alongside the CLI
-- Discovered automatically at runtime
-
-**Note:** This plugin is NOT a dependency of deepctl. It must be installed separately to demonstrate how the plugin system works for third-party developers. This example plugin is published to PyPI with each deepctl release to ensure the documentation is always testable.
-
-## Installation
-
-### Development Installation
-
-To install the plugin in development mode:
-
-```bash
-# From the plugin directory
-pip install -e .
-
-# Or using uv
-uv pip install -e .
-```
-
-### Production Installation
-
-For users who have deepctl installed globally:
-
-```bash
-# Recommended: Using pipx (if deepctl was installed with pipx)
-pipx install deepctl  # If not already installed
-pipx inject deepctl deepctl-plugin-example
-
-# Alternative: Using pip (only works in development environments)
-pip install deepctl deepctl-plugin-example
-```
-
-**Note:** If you installed deepctl with `uv tool install`, plugin installation requires manual workarounds. We recommend using pipx for the best plugin experience.
-
-## Usage
-
-Once installed, the plugin command becomes available in the CLI:
-
-```bash
-# Basic usage
-deepctl example
-
-# Custom greeting
-deepctl example --greeting "Howdy" --name "Partner"
-
-# Show plugin system information
-deepctl example --show-info
-```
-
-## How It Works
-
-1. **Entry Point Registration**: The plugin registers itself via the `deepctl.plugins` entry point in `pyproject.toml`
-2. **Command Discovery**: The CLI's PluginManager discovers the plugin at runtime using `importlib.metadata`
-3. **Command Loading**: The plugin's command class is instantiated and added to the CLI
-4. **Execution**: When the user runs the command, the plugin's `handle()` method is called
-
-## Creating Your Own Plugin
-
-To create your own deepctl plugin:
-
-1. **Copy this example package** as a starting point
-2. **Rename the package** and update metadata in `pyproject.toml`
-3. **Implement your command** by modifying the `command.py` file
-4. **Define arguments** in the `get_arguments()` method
-5. **Implement logic** in the `handle()` method
-6. **Test locally** with `pip install -e .`
-7. **Publish to PyPI** when ready
-8. **Users install it** with `pipx inject deepctl your-plugin-name`
-
-### Key Requirements
-
-- Must inherit from `deepctl_core.BaseCommand`
-- Must implement required properties: `name`, `help`
-- Must implement `handle()` method
-- Must be registered via entry point
-
-### Example Command Structure
-
-```python
-from deepctl_core import BaseCommand
-
-class MyCommand(BaseCommand):
-    name = "mycommand"
-    help = "Description of my command"
-
-    def handle(self, config, auth_manager, client, **kwargs):
-        # Your command logic here
-        pass
-```
-
-## Development
-
-### Running Tests
-
-```bash
-uv run pytest
-```
-
-### Building the Package
-
-```bash
-python -m build
-```
-
-## Plugin Capabilities
-
-Plugins have access to:
-
-- Configuration management via `Config`
-- Authentication via `AuthManager`
-- Deepgram API client via `DeepgramClient`
-- Rich terminal output via `rich`
-- Command-line argument parsing via `click`
-
-## License
-
-MIT