WIP: change CLI backend to typer #78

abhijeetSaroha · 2023-12-27T22:19:04Z

Created the new CLI file with typer named with makim_cli.py and change the __main__.py accordingly.

As issue completely solved, I will change the name to cli.py.

Solves #76

abhijeetSaroha · 2023-12-27T22:21:09Z

The one problem that I am currently facing is for --clean as it is used in only two run commands of .makim.yaml file. Could you please tell me more detail about this?

Because in previous cli.py file also there is no mention of --clean flag.

xmnlab

I will test your branch locally.
But at the mean time I added some notes here

pyproject.toml

xmnlab · 2023-12-28T00:33:14Z

src/makim/makim_cli.py

@@ -0,0 +1,203 @@
+"""


@abhijeetSaroha

Why you are creating a new module, instead of using cli.py?

For now, I have created a new module. When it will complete, I will remove the previous cli.py and change this one to cli.py .
I do this so that functioning of makim continue until new cli with typer fully created.

But if you want I will remove the previous one.

yep .. feel free to remove it ... you always can check the current version on github .. so no worries about that file :)

xmnlab · 2023-12-28T00:39:39Z

The one problem that I am currently facing is for --clean as it is used in only two run commands of .makim.yaml file. Could you please tell me more detail about this?

Because in previous cli.py file also there is no mention of --clean flag.

Makim is a tool for dynamic creating a CLI from specifications defined in .makim.yaml

--clean is not part of the built-in makim options, instead it is something defined for our .makim.yaml .. that config file is used for makim development only ... it is not something that would be used out side our development. Any other projects that use makim, can define their own set of group and targets.

src/makim/makim_cli.py

xmnlab · 2023-12-28T02:12:21Z

src/makim/makim_cli.py

+    echo(help_text)
+
+
+def format_help_text(description, usage, epilog, target_help):


you probably don't need to reimplement the help ..
you should use the one from typer .. in another words, you don't need to create it manually ..
just need to create the functions with the correct arguments for each target, and add the correct help text for that, and typer will create the help menu for you. similar to what I shared in the issue.

src/makim/makim_cli.py

xmnlab · 2023-12-28T02:13:40Z

thank you @abhijeetSaroha for working on that!
I just added more comments here.

felipepaes · 2023-12-29T13:46:20Z

Hi @abhijeetSaroha, pleased to meet you!

I will be helping you with makim PRs since @xmnlab won't be able to test things on his computer for the next few days.

Please let me know if you need anything, whether it's for testing the PRs, exchanging/sharing ideas, or discussing opinions about the project.

I'm also on the Discord server. My timezone is GMT-3, but feel free to contact me at any time, ok?

felipepaes · 2023-12-29T13:55:11Z

I'm working on a feature (issue 30 ) for makim as well, so I will need to learn more about Typer. Currently I have added new options to the parser so that we could have something like this:

makim cron run backup
makim cron install backup
makim cron remove backup

Basically I have added a subcommand called cron which can add makim commands as cron jobs that are executed by the system via cron at specific set times.

Since we are going for Typer, I will be reading this piece of documentation about subcommands with Typer

Please let me know if you have any resources about Typer that you would recommend.

xmnlab · 2023-12-29T15:23:02Z

That looks nice, probably something that I would need to do for envers as well

abhijeetSaroha · 2023-12-29T15:38:05Z

Hi @abhijeetSaroha, pleased to meet you!

I will be helping you with makim PRs since @xmnlab won't be able to test things on his computer for the next few days.

Please let me know if you need anything, whether it's for testing the PRs, exchanging/sharing ideas, or discussing opinions about the project.

I'm also on the Discord server. My timezone is GMT-3, but feel free to contact me at any time, ok?

Pleased to meet you too @felipepaes sir.

abhijeetSaroha · 2023-12-30T10:44:28Z

@felipepaes I am not able to dynamically create command and create help text automatically.
As @xmnlab , give example here.

Can you give some more idea about this?

felipepaes · 2024-01-03T01:01:46Z

@felipepaes I am not able to dynamically create command and create help text automatically. As @xmnlab , give example here.

Can you give some more idea about this?

Sorry @abhijeetSaroha I was at a retreat with family.

So, on that example he's getting the help from the targets defined in .makim.yaml, as an example he's already defining it as dictionary named targets.

Did you mean to generate the help text based on the .makim.yaml targets' args or the command help text?

felipepaes · 2024-01-03T01:08:13Z

Typer should automatically fetch the arguments and options when you use the --help option, but you can also pass a general cli help text when instantiating the Typer object.

app = typer.Typer(help="Awesome CLI user manager.")

source

xmnlab · 2024-01-03T15:11:10Z

@abhijeetSaroha could you share more about the error you have? is there your code already here on github?
if so I can test it locally

xmnlab · 2024-01-03T15:12:59Z

src/makim/cli.py

+@app.callback(invoke_without_command=True)
+def main(
+    # Common Options
+    help: bool = Option(


you probably don't need to specify help manually.

xmnlab · 2024-01-03T15:13:57Z

src/makim/cli.py

+
+    args = {
+        'dry_run': dry_run,
+        'help': help,


you also probably don't need to use help here
let's have typer to handle the help automatically

xmnlab · 2024-01-03T15:17:49Z

src/makim/cli.py

+        'version': version,
+    }
+
+    makim.load(makim_file)


not sure if that is the write way to work with makim and typer together

in this main function you probably should allow makim-file, and version.

for the other commands you will need to implement (for each one) verbose, dry-run and makim-file

the target you can set manually for each one, because each command will trigger just one function

does it make sense?

btw, let me know if this one is too complex for you ... and I can work on this one.
this one is really tricky because it is not using the default workflow for typer

Let me try one more time, then I will report to you.

xmnlab · 2024-01-12T17:36:14Z

superseded by #82

change backend to typer

3652717

add typer to dependencies

b61fa8d

xmnlab requested changes Dec 28, 2023

View reviewed changes

xmnlab reviewed Dec 28, 2023

View reviewed changes

src/makim/makim_cli.py Outdated Show resolved Hide resolved

xmnlab reviewed Dec 28, 2023

View reviewed changes

src/makim/makim_cli.py Outdated Show resolved Hide resolved

abhijeetSaroha added 4 commits December 28, 2023 10:37

change ^ to >=

4c1f8c3

remove print statement and extract_makim_args() method

b09fb11

remove makim_cli.py

fff9026

update files

0453a4e

xmnlab reviewed Jan 3, 2024

View reviewed changes

xmnlab closed this Jan 12, 2024

abhijeetSaroha deleted the cli-typer branch January 15, 2024 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: change CLI backend to typer #78

WIP: change CLI backend to typer #78

abhijeetSaroha commented Dec 27, 2023

abhijeetSaroha commented Dec 27, 2023 •

edited

Loading

xmnlab left a comment

xmnlab Dec 28, 2023

abhijeetSaroha Dec 28, 2023

xmnlab Dec 28, 2023

xmnlab commented Dec 28, 2023

xmnlab Dec 28, 2023

xmnlab commented Dec 28, 2023

felipepaes commented Dec 29, 2023

felipepaes commented Dec 29, 2023

xmnlab commented Dec 29, 2023

abhijeetSaroha commented Dec 29, 2023

abhijeetSaroha commented Dec 30, 2023

felipepaes commented Jan 3, 2024

felipepaes commented Jan 3, 2024

xmnlab commented Jan 3, 2024

xmnlab Jan 3, 2024

xmnlab Jan 3, 2024

xmnlab Jan 3, 2024

xmnlab Jan 3, 2024

abhijeetSaroha Jan 3, 2024 •

edited

Loading

xmnlab commented Jan 12, 2024

		echo(help_text)


		def format_help_text(description, usage, epilog, target_help):

WIP: change CLI backend to typer #78

WIP: change CLI backend to typer #78

Conversation

abhijeetSaroha commented Dec 27, 2023

abhijeetSaroha commented Dec 27, 2023 • edited Loading

xmnlab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xmnlab commented Dec 28, 2023

Choose a reason for hiding this comment

xmnlab commented Dec 28, 2023

felipepaes commented Dec 29, 2023

felipepaes commented Dec 29, 2023

xmnlab commented Dec 29, 2023

abhijeetSaroha commented Dec 29, 2023

abhijeetSaroha commented Dec 30, 2023

felipepaes commented Jan 3, 2024

felipepaes commented Jan 3, 2024

xmnlab commented Jan 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abhijeetSaroha Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

xmnlab commented Jan 12, 2024

abhijeetSaroha commented Dec 27, 2023 •

edited

Loading

abhijeetSaroha Jan 3, 2024 •

edited

Loading