Skip to content

Commit 639da3a

Browse files
tedhabecktedhabeck
committed
chore: update README.md
Signed-off-by: habeck <habeck@us.ibm.com>
1 parent 91e4ca6 commit 639da3a

1 file changed

Lines changed: 27 additions & 15 deletions

File tree

‎cpex/tools/README.md‎

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@
77

88
List, search, install or uninstall plugins.
99

10-
default install type is monorepo
11-
Examples:
12-
python cpex/tools/cli.py plugin info pii
13-
python cpex/tools/cli.py plugin search pii
14-
python cpex/tools/cli.py plugin --type monorepo search pii
15-
python cpex/tools/cli.py plugin --type monorepo install cpex-pii-filter
16-
python cpex/tools/cli.py plugin --type pypi install "ExamplePlugin@>=0.1.0"
17-
python cpex/tools/cli.py plugin --type test-pypi install "cpex-plugin-test@>=0.1.1"
18-
python cpex/tools/cli.py plugin uninstall cpex-pii-filter
19-
10+
default install type is monorepo
11+
Examples:
12+
python cpex/tools/cli.py plugin info pii
13+
python cpex/tools/cli.py plugin search pii
14+
python cpex/tools/cli.py plugin --type monorepo search pii
15+
python cpex/tools/cli.py plugin --type monorepo install cpex-pii-filter
16+
python cpex/tools/cli.py plugin --type pypi install "ExamplePlugin@>=0.1.0"
17+
python cpex/tools/cli.py plugin --type test-pypi install "cpex-test-plugin@>=0.1.1"
18+
python cpex/tools/cli.py plugin --type git install "cpex-test-plugin @ git+https://github.com/tedhabeck/cpex-test-plugin@main"
19+
python cpex/tools/cli.py plugin versions cpex-test-plugin
20+
python cpex/tools/cli.py plugin uninstall cpex-pii-filter.
21+
2022
╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
2123
│ cmd_action [CMD_ACTION] One of: list|info|install|search|uninstall │
2224
│ source [SOURCE] The pypi, git, or local folder where the plugin resides │
@@ -112,6 +114,16 @@ sequenceDiagram
112114
participant pypi (Python Package Index)
113115
User->>cli: python cpex/tools/cli.py plugin --type pypi install <package_name><version_constaint>
114116
cli->>catalog: install_from_pypi(<package_name><version_constraint>
117+
catalog->>subprocess: python -m pip download <package_name><version_constraint> to temp
118+
subprocess->>python: -m pip download <package_name><version_constraint> to temp
119+
python->>pip: download <package_name><version_constraint>
120+
pip->>pypi (Python Package Index): download <package_name> to temp
121+
pypi (Python Package Index)->>python: downloaded OK
122+
python->>subprocess: rc=0
123+
subprocess->>catalog: extracted_folder
124+
catalog->>catalog: Loads and parse the plugin-manifest.yaml
125+
catalog->>catalog: if manifest.kind is isolated_venv initialize isolated venv and STOP here.
126+
catalog->>cli: PluginManifest (isolated_venv)
115127
catalog->>subprocess: python -m pip install <package_name><version_constraint>
116128
subprocess->>python: -m pip install <package_name><version_constraint>
117129
python->>pip: install <package_name><version_constraint>
@@ -162,12 +174,12 @@ Example output:
162174
{
163175
"name": "cpex-test-plugin",
164176
"kind": "isolated_venv",
165-
"version": "0.1.1",
166-
"installation_type": "pypi",
167-
"installation_path": "/Users/habeck/.venv/cpex/lib/python3.13/site-packages/cpex_test_plugin",
168-
"installed_at": "2026-04-20T22:09:52.198619+00:00Z",
177+
"version": "0.2.0",
178+
"installation_type": "monorepo",
179+
"installation_path": "/Users/habeck/tedhabeck/contextforge-plugins-framework/plugins/cpex_test_plugin/.venv/lib/python3.13/site-packages/cpex_test_plugin",
180+
"installed_at": "2026-05-01T00:14:26.123924+00:00Z",
169181
"installed_by": "habeck",
170-
"package_source": "cpex-test-plugin",
182+
"package_source": "https://github.com/tedhabeck/cpex-test-plugin",
171183
"editable": false
172184
}
173185
```

0 commit comments

Comments
 (0)