diff options
Diffstat (limited to 'python-vdk-control-cli.spec')
| -rw-r--r-- | python-vdk-control-cli.spec | 348 |
1 files changed, 348 insertions, 0 deletions
diff --git a/python-vdk-control-cli.spec b/python-vdk-control-cli.spec new file mode 100644 index 0000000..440b135 --- /dev/null +++ b/python-vdk-control-cli.spec @@ -0,0 +1,348 @@ +%global _empty_manifest_terminate_build 0 +Name: python-vdk-control-cli +Version: 1.3.864600569 +Release: 1 +Summary: VDK Control CLI allows user to create, delete, manage and their Data Jobs in Kubernetes runtime. +License: Apache Software License +URL: https://github.com/vmware/versatile-data-kit +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/53/a8/8d1e5060ad060a0541491113a22f3f02d3eb5588bbe9f406ce981cbbf786/vdk-control-cli-1.3.864600569.tar.gz +BuildArch: noarch + + +%description +# Versatile Data Kit Control CLI + +VDK Control CLI is meant for Data Engineers to use to manage the lifecycle of jobs - create, delete, deploy, configure Data Jobs. + +To build or contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md). + +## Installation +Install VDK Control CLI with: +```bash +pip install vdk-control-cli +``` +This will install console application called `vdkcli` + +Then run help to see what it can do: +```bash +vdkcli --help +``` + +`vdkcli` is the name of the console application only when vdk-control-cli is installed autonomously. Typically, +it is a dependency of Versatile Data Kit and the console application is `vdk` (hence, all commands in error and help +messages in this project refer to `vdk`). Keep in mind that if you are using this project autonomously, you should +use `vdkcli` command instead of `vdk`. + +### Environment variables: + +* VDK_BASE_CONFIG_FOLDER - Override local base configuration folder (by default in $HOME folder). Inside it will create folder .vdk.internal. + CLI state may be kept there (login info). Use in case multiple users need to login (e.g in case of automation) on same machine. + +* VDK_CONTROL_SERVICE_REST_API_URL - Default Control Service URL to use if not specified as command line argument +* VDK_API_TOKEN - Default API Token to use if another authentication has not been used with vdk login +* VDK_API_TOKEN_AUTHORIZATION_URL - Default API token URL to use if another authentication has not been used with vdk login. + +### Security +If Control Service configured require authentication: vdk login must have finished successfully. +Or alternatively correct VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN must be set correctly and will behave same as `vdk login -t api-token`. +If vdk login is used - it take priority over environment variables set VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN +To clear previous login info (aka logout) use `vdk logout`. + +In case of credentials type vdk login flow we start a process on port `31113` to receive the credentials. +If you already have process running on `31113` you can override the value. +To override the port set environmental variable `OAUTH_PORT` with free port which the client can use. + +## Plugins + +### Installing and Using plugins + +Installing a third party plugin can be easily done with pip: + +```bash +pip install vdk-control-cli-NAME +pip uninstall vdk-control-cli-NAME +``` +If a plugin is installed, vdk automatically finds and integrates it. + +### Write your own plugin + +A plugin is python module that enhances or changes the behaviour of the vdk cli. <br> +A plugin contains one or multiple hook functions. + +See all supported hook function specifications that can be implemented in [specs.py](src/vdk/api/control/plugin/specs.py) + +In order to create a new plugin there are only 2 steps:<br> + +* Create your implementation of the plugin's hook(s): +```python +# define hookimpl as follows (library requirement: pluggy) +hookimpl = pluggy.HookimplMarker("vdk_control_cli.plugin") +# though it's better to use `vdk.internal.control.plugin.markers.hookimpl` from vdk-control-cli python package + +# name of function must match name of hookspec function +@hookimpl +def get_default_commands_options(): + # your implementation here ; for example to set defaults for `vdk login --type --oauth2-authorization-url` command + default_options = { + "login": { + "auth_type": "api-token", # note values must be valid or the plugin may break the CLI, no checking is done at this point + "api_token_authorization_url": "http://localhost/authorize" # replace dashes with underscore for the argument name + } + } + return default_options +``` +* Register as plugin by listing the plugin modules in vdk_control_cli.plugin entry_point in your setup.py: +```python + entry_points={ 'vdk_control_cli.plugin': ['name_of_plugin = myproject.pluginmodule'] } +``` + +<br>The plugin system is based on [pluggy.](https://pluggy.readthedocs.io/en/latest/index.html#implementations) +<br>SDK Extensibility design can be seen [here](https://github.com/vmware/versatile-data-kit/tree/main/specs) + +## Authentication + +In order to use credentials login type you need to create OAuth2 Application. + + +%package -n python3-vdk-control-cli +Summary: VDK Control CLI allows user to create, delete, manage and their Data Jobs in Kubernetes runtime. +Provides: python-vdk-control-cli +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-vdk-control-cli +# Versatile Data Kit Control CLI + +VDK Control CLI is meant for Data Engineers to use to manage the lifecycle of jobs - create, delete, deploy, configure Data Jobs. + +To build or contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md). + +## Installation +Install VDK Control CLI with: +```bash +pip install vdk-control-cli +``` +This will install console application called `vdkcli` + +Then run help to see what it can do: +```bash +vdkcli --help +``` + +`vdkcli` is the name of the console application only when vdk-control-cli is installed autonomously. Typically, +it is a dependency of Versatile Data Kit and the console application is `vdk` (hence, all commands in error and help +messages in this project refer to `vdk`). Keep in mind that if you are using this project autonomously, you should +use `vdkcli` command instead of `vdk`. + +### Environment variables: + +* VDK_BASE_CONFIG_FOLDER - Override local base configuration folder (by default in $HOME folder). Inside it will create folder .vdk.internal. + CLI state may be kept there (login info). Use in case multiple users need to login (e.g in case of automation) on same machine. + +* VDK_CONTROL_SERVICE_REST_API_URL - Default Control Service URL to use if not specified as command line argument +* VDK_API_TOKEN - Default API Token to use if another authentication has not been used with vdk login +* VDK_API_TOKEN_AUTHORIZATION_URL - Default API token URL to use if another authentication has not been used with vdk login. + +### Security +If Control Service configured require authentication: vdk login must have finished successfully. +Or alternatively correct VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN must be set correctly and will behave same as `vdk login -t api-token`. +If vdk login is used - it take priority over environment variables set VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN +To clear previous login info (aka logout) use `vdk logout`. + +In case of credentials type vdk login flow we start a process on port `31113` to receive the credentials. +If you already have process running on `31113` you can override the value. +To override the port set environmental variable `OAUTH_PORT` with free port which the client can use. + +## Plugins + +### Installing and Using plugins + +Installing a third party plugin can be easily done with pip: + +```bash +pip install vdk-control-cli-NAME +pip uninstall vdk-control-cli-NAME +``` +If a plugin is installed, vdk automatically finds and integrates it. + +### Write your own plugin + +A plugin is python module that enhances or changes the behaviour of the vdk cli. <br> +A plugin contains one or multiple hook functions. + +See all supported hook function specifications that can be implemented in [specs.py](src/vdk/api/control/plugin/specs.py) + +In order to create a new plugin there are only 2 steps:<br> + +* Create your implementation of the plugin's hook(s): +```python +# define hookimpl as follows (library requirement: pluggy) +hookimpl = pluggy.HookimplMarker("vdk_control_cli.plugin") +# though it's better to use `vdk.internal.control.plugin.markers.hookimpl` from vdk-control-cli python package + +# name of function must match name of hookspec function +@hookimpl +def get_default_commands_options(): + # your implementation here ; for example to set defaults for `vdk login --type --oauth2-authorization-url` command + default_options = { + "login": { + "auth_type": "api-token", # note values must be valid or the plugin may break the CLI, no checking is done at this point + "api_token_authorization_url": "http://localhost/authorize" # replace dashes with underscore for the argument name + } + } + return default_options +``` +* Register as plugin by listing the plugin modules in vdk_control_cli.plugin entry_point in your setup.py: +```python + entry_points={ 'vdk_control_cli.plugin': ['name_of_plugin = myproject.pluginmodule'] } +``` + +<br>The plugin system is based on [pluggy.](https://pluggy.readthedocs.io/en/latest/index.html#implementations) +<br>SDK Extensibility design can be seen [here](https://github.com/vmware/versatile-data-kit/tree/main/specs) + +## Authentication + +In order to use credentials login type you need to create OAuth2 Application. + + +%package help +Summary: Development documents and examples for vdk-control-cli +Provides: python3-vdk-control-cli-doc +%description help +# Versatile Data Kit Control CLI + +VDK Control CLI is meant for Data Engineers to use to manage the lifecycle of jobs - create, delete, deploy, configure Data Jobs. + +To build or contribute, see [CONTRIBUTING.md](./CONTRIBUTING.md). + +## Installation +Install VDK Control CLI with: +```bash +pip install vdk-control-cli +``` +This will install console application called `vdkcli` + +Then run help to see what it can do: +```bash +vdkcli --help +``` + +`vdkcli` is the name of the console application only when vdk-control-cli is installed autonomously. Typically, +it is a dependency of Versatile Data Kit and the console application is `vdk` (hence, all commands in error and help +messages in this project refer to `vdk`). Keep in mind that if you are using this project autonomously, you should +use `vdkcli` command instead of `vdk`. + +### Environment variables: + +* VDK_BASE_CONFIG_FOLDER - Override local base configuration folder (by default in $HOME folder). Inside it will create folder .vdk.internal. + CLI state may be kept there (login info). Use in case multiple users need to login (e.g in case of automation) on same machine. + +* VDK_CONTROL_SERVICE_REST_API_URL - Default Control Service URL to use if not specified as command line argument +* VDK_API_TOKEN - Default API Token to use if another authentication has not been used with vdk login +* VDK_API_TOKEN_AUTHORIZATION_URL - Default API token URL to use if another authentication has not been used with vdk login. + +### Security +If Control Service configured require authentication: vdk login must have finished successfully. +Or alternatively correct VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN must be set correctly and will behave same as `vdk login -t api-token`. +If vdk login is used - it take priority over environment variables set VDK_API_TOKEN_AUTHORIZATION_URL and VDK_API_TOKEN +To clear previous login info (aka logout) use `vdk logout`. + +In case of credentials type vdk login flow we start a process on port `31113` to receive the credentials. +If you already have process running on `31113` you can override the value. +To override the port set environmental variable `OAUTH_PORT` with free port which the client can use. + +## Plugins + +### Installing and Using plugins + +Installing a third party plugin can be easily done with pip: + +```bash +pip install vdk-control-cli-NAME +pip uninstall vdk-control-cli-NAME +``` +If a plugin is installed, vdk automatically finds and integrates it. + +### Write your own plugin + +A plugin is python module that enhances or changes the behaviour of the vdk cli. <br> +A plugin contains one or multiple hook functions. + +See all supported hook function specifications that can be implemented in [specs.py](src/vdk/api/control/plugin/specs.py) + +In order to create a new plugin there are only 2 steps:<br> + +* Create your implementation of the plugin's hook(s): +```python +# define hookimpl as follows (library requirement: pluggy) +hookimpl = pluggy.HookimplMarker("vdk_control_cli.plugin") +# though it's better to use `vdk.internal.control.plugin.markers.hookimpl` from vdk-control-cli python package + +# name of function must match name of hookspec function +@hookimpl +def get_default_commands_options(): + # your implementation here ; for example to set defaults for `vdk login --type --oauth2-authorization-url` command + default_options = { + "login": { + "auth_type": "api-token", # note values must be valid or the plugin may break the CLI, no checking is done at this point + "api_token_authorization_url": "http://localhost/authorize" # replace dashes with underscore for the argument name + } + } + return default_options +``` +* Register as plugin by listing the plugin modules in vdk_control_cli.plugin entry_point in your setup.py: +```python + entry_points={ 'vdk_control_cli.plugin': ['name_of_plugin = myproject.pluginmodule'] } +``` + +<br>The plugin system is based on [pluggy.](https://pluggy.readthedocs.io/en/latest/index.html#implementations) +<br>SDK Extensibility design can be seen [here](https://github.com/vmware/versatile-data-kit/tree/main/specs) + +## Authentication + +In order to use credentials login type you need to create OAuth2 Application. + + +%prep +%autosetup -n vdk-control-cli-1.3.864600569 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-vdk-control-cli -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 1.3.864600569-1 +- Package Spec generated |