Skip to content

admin workspace python Command Group¤

List, install, or uninstall python packages.

Python packages are used to extend the Build (DataIntegration) workspace with python plugins. To get a list of installed packages, execute the list command.

Warning

Installing packages from unknown sources is not recommended. Plugins are not verified for malicious code.

admin workspace python install¤

Install a python package to the workspace.

Usage
$ cmemc admin workspace python install PACKAGE

This command is essentially a pip install in the remote python environment.

You can install a package by uploading a source distribution .tar.gz file, by uploading a build distribution .whl file, or by specifying a package name, i.e., a pip requirement specifier with a package name available on pypi.org (e.g. requests==2.27.1).

Note

The tab-completion of this command lists only public packages from pypi.org and not from additional or changed python package repositories you may have configured on the server.

admin workspace python uninstall¤

Uninstall a python packages from the workspace.

Usage
$ cmemc admin workspace python uninstall [OPTIONS] [PACKAGE_NAME]...

This command is essentially a pip uninstall in the remote python environment.

Options 
-a, --all   This option removes all installed packages from the system,
            leaving only the pre-installed mandatory packages in the
            environment.

admin workspace python list¤

List installed python packages.

Usage
$ cmemc admin workspace python list [OPTIONS]

This command is essentially a pip list in the remote python environment.

It outputs a table of python package identifiers with version information.

Options 
--raw        Outputs raw JSON.
--id-only    Lists only package identifier. This is useful for piping the
             IDs into other commands.
--available  Instead of listing installed packages, this option lists
             installable packages from pypi.org, which are prefixed with
             'cmem-plugin-' and so are most likely Corporate Memory plugin
             packages.

admin workspace python list-plugins¤

List installed workspace plugins.

Usage
$ cmemc admin workspace python list-plugins [OPTIONS]

This commands lists all discovered plugins.

Note

The plugin discovery is restricted to package prefix (cmem-).

Options 
--raw              Outputs raw JSON.
--id-only          Lists only plugin identifier.
--package-id-only  Lists only plugin package identifier.

admin workspace python open¤

Open a package pypi.org page in the browser.

Usage
$ cmemc admin workspace python open PACKAGE

With this command, you can open the pypi.org page of a published package in your browser. From there, you can follow links, review the version history as well as the origin of the package, and read the provided documentation.

admin workspace python reload¤

Reload / Register all installed plugins.

Usage
$ cmemc admin workspace python reload

This command will register all installed plugins into the Build (DataIntegration) workspace. This command is useful, when you are installing packages into the Build Python environment without using the provided cmemc commands (e.g. by mounting a prepared filesystem in the docker container).

Comments