Package Python CLI tool in the binary distribution

[flyrain]

Users who only have the binary distribution can use the CLI directly from the package. There is no need to grab the tools from anywhere else, like github, or src distribution.

[MonkeyCanCode]

Thanks for bring this up @flyrain. Here are my two cents:

Before we can do so, we should fix couple old issues we have with client code such as following

1. remove doc generation from openapi as those will get include and those are not very useful
2. hide the lengthy "[main] ERROR o.o.codegen.DefaultCodegen - Required var xxx not in properties" when invoking openapi to generate client code
3. decide what to publish (sdist or wheel or both?). see my sample PR in Add support for poetry build with wheel #2425
4. remove the needed of SCRIPT_DIR when invoking polaris as we should really using <home_dir>/.polaris instead imo (see previous discussion in Add profile support for cli #931)
5. rename bash script polaris on the root directory to something else such as client_setup.sh etc. to avoid confusion as now the client python will create a polaris binary file.

I can help fixing all of the above and open for more inputs as well. But before I proceed with more PRs, I would like to get some feedbacks for the above.

cc. @eric-maynard @HonahX

[flyrain]

The plan sounds great to me. Thanks @MonkeyCanCode for picking it up! At least, we will need to fix item 3 and 4 before packaging it the binary distribution.

[MonkeyCanCode]

The plan sounds great to me. Thanks @MonkeyCanCode for picking it up! At least, we will need to fix item 3 and 4 before packaging it the binary distribution.

Thanks for review. Here is sample PR for 1 and 2: #2439.

For 3, a sample PR is already created. For 4, it may be good to check with @HonahX and @eric-maynard on this first as the previous discussion is to introduce SCRIPT_DIR. However, as we are trying to publish a share-able package, asking users to specify SCRIPT_DIR doesn't make much sense anymore imo. Thus, we should do the similar (e.g. aws/maven/jenv/gloo/etc.) to default to {HOME}/.polaris directory (or even a single file if we don't think we will have more files later on)

[flyrain]

Thanks @MonkeyCanCode . Could you share these PRs?

asking users to specify SCRIPT_DIR doesn't make much sense anymore imo.

Agreed.

[MonkeyCanCode]

Thanks @MonkeyCanCode . Could you share these PRs?

asking users to specify SCRIPT_DIR doesn't make much sense anymore imo.

Agreed.

I can work on this later tonight then share for removing SCRIPT_DIR. But other than this and the rename of polaris script, all other ones that I think we should change are linked in the above.

[MonkeyCanCode]

Thanks @MonkeyCanCode . Could you share these PRs?

asking users to specify SCRIPT_DIR doesn't make much sense anymore imo.

Agreed.

I can work on this later tonight then share for removing SCRIPT_DIR. But other than this and the rename of polaris script, all other ones that I think we should change are linked in the above.

Here is the sample PR: #2448 (basically it contains the changes I have in my original PR when profiles option was introduced: c667139)

As now people may be using this already, we may need to make it backward compatible by introducing an optional flag to overwrite it. Let run by @eric-maynard and @HonahX on this before I add more code in.