Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.0 Discussion #1044

Closed
kmvanbrunt opened this issue Jan 21, 2021 · 13 comments
Closed

2.0 Discussion #1044

kmvanbrunt opened this issue Jan 21, 2021 · 13 comments
Labels
Milestone

Comments

@kmvanbrunt
Copy link
Member

kmvanbrunt commented Jan 21, 2021

@anselor @tleonhardt
I'd like to move toward getting cmd2 2.0 released. What needs to get done before we do?

My list

@kmvanbrunt kmvanbrunt added this to the 2.0.0 milestone Jan 21, 2021
@anselor
Copy link
Contributor

anselor commented Jan 22, 2021

Not exciting work, but updating the examples to be up to date with our latest improvements is probably a good thing to do. #1000

Also, #1010 suppressing output of startup scripts.

passing both flake8 and mypy with type annotations throughout would be nice too.

#965 per-CommandSet settables

@kmvanbrunt
Copy link
Member Author

kmvanbrunt commented Jan 22, 2021

We also need to remove the with_argparser_and_unknown_args decorator on the 2.0 branch since it was deprecated.

EDIT: This has been completed

@kmvanbrunt
Copy link
Member Author

#1010 has a PR out for it now

@tleonhardt
Copy link
Member

tleonhardt commented Jan 23, 2021

The things I think are most important are:

The first two are really infrastructure changes, but important ones. The last one is a breaking change that should be done as part of the 2.0 release.

But practically speaking, the slow CI issue is the most important overall.

@jayrod
Copy link
Contributor

jayrod commented Jan 24, 2021

On the user end of things, the most awesome thing about cmd2 is how it allows you to rapidly build a feature rich application with minimal effort. The simple app is well, simple and if you look at the larger applications they are exceedingly complex.

It is difficult for those of us that are advanced but unable to really grok some of the complexities of cmd2.

I.e. you have a plugin example project but its not very effective of guiding you through the framework.

I propose we distill best practices into cookiecutter templates focusing on creating deliverable cmd2 applications.

@anselor
Copy link
Contributor

anselor commented Jan 24, 2021

@jayrod Take a look at #1000

I was trying to go through and annotate the purpose of each example we have. Probably worthwhile to discuss what examples are missing.

For some if the more complicated features it'll probably actually make more sense to develop a stand-alone app to demonstrate what it does.

@anselor
Copy link
Contributor

anselor commented Mar 16, 2021

PR #1074 Is out and related to this.

@anselor
Copy link
Contributor

anselor commented Mar 16, 2021

I think we should try to fully adopt pathlib in our APIs before the 2.0 switch as well.

What do you think, @tleonhardt @kmvanbrunt

@tleonhardt
Copy link
Member

I’m a huge fan of both pathlib and f-strings. But I’m also a fan of not fixing what isn’t broke. So I could go either way.

@anselor
Copy link
Contributor

anselor commented Mar 16, 2021

My specific concern is I'd like to get everything API breaking in together in 2.0 release if possible. So if there are places on our APIs that would benefit from pathlib I'd rather take the hit now than later.

@kmvanbrunt
Copy link
Member Author

@tleonhardt @anselor
f-string conversion was completed in #1092.
pathlib support can be added later by converting applicable argument types to Union[str, pathlib.Path].

If this approach is acceptable, are we good for releasing 2.0 soon?

@tleonhardt
Copy link
Member

I think now is a fine time for the 2.0 release and we should get it out very soon to help avoid further customer confusion with examples not working with the latest version of cmd2 installed from pip.

@kmvanbrunt
Copy link
Member Author

Closing since 2.0.0 is out

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants