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

Create setup TUI and improve overall UX #125

Merged
merged 27 commits into from
Jun 5, 2022
Merged

Create setup TUI and improve overall UX #125

merged 27 commits into from
Jun 5, 2022

Conversation

blockarchitech
Copy link
Contributor

This pull request adds and/or changes the following:

  • Create a TUI for initial set-up.
  • Added pycaches to .gitignore
  • Fixed requirements.txt ([Enhancement] TUI Setup Interface #16 comment three)
  • Added a little for verbose for easier error reading.
  • Added a loader icon which can be used for almost anything.
  • Now in full color!

Fixes/Closes #16

@blockarchitech
Copy link
Contributor Author

Also, I'd recommend putting an open-source license in this project.

main.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@JasonLovesDoggo JasonLovesDoggo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall great, just would recommend system cross-compatibility and .casefold() on some checks

Copy link
Contributor

@owengaspard owengaspard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work! I suggest that, in addition to checking for missing environment variables, there can be either an env variable or a dotfile that allows the program to know that the setup wizard has been run before.
For example, you can use the os.path.exists function to check if .setup-run-before exists. If not, it asks if the user wants to run the program. If it does, check for missing environment variables.

from os.path import exists

setup_done = exists(.setup-run-before)

so on and so fourth

@blockarchitech
Copy link
Contributor Author

I'll get this added, @owengaspard!

@Shadowles19
Copy link

I'll get this added, @owengaspard!

Hey can you let me know when you add those! I would love to use this.

@blockarchitech
Copy link
Contributor Author

Done! @Shadowles19 if you want to try this out, git clone https://github.com/BlockArchitech/RedditVideoMakerBot and follow the README in that repository.

@blockarchitech
Copy link
Contributor Author

@Kamushy, @owengaspard, @JasonLovesDoggo I've added your changes!

@blockarchitech
Copy link
Contributor Author

Ah, doesn't everyone love merge conflicts? I'll get this fixed @elebumm

@blockarchitech
Copy link
Contributor Author

Alright, I'm going to add the new 2fa variable to the new setup script. Give me a moment.

@blockarchitech
Copy link
Contributor Author

Unfortunately, the new color-coded console I added doesn't look like it will work with the new script. However, it does already have better logging than it used to.

@elebumm this is ready to be reviewed!

@blockarchitech
Copy link
Contributor Author

Merge conflicts are resolved. Now it's extra ready for review, @elebumm!

.gitignore Outdated Show resolved Hide resolved
Copy link
Contributor Author

@blockarchitech blockarchitech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not appear there are any more conflicts.

@blockarchitech
Copy link
Contributor Author

I'm going to add the new variables to the setup assistant soon.

@blockarchitech
Copy link
Contributor Author

Merge Conflicts fixed again.

@elebumm
Copy link
Owner

elebumm commented Jun 5, 2022

@blockarchitech Incredible PR. I had some issues with some of the merge conflicts. I also added the load_dotenv at the beginning because it wasn't recognizing my PR's.

I will add this in straight away if we can quickly have those resolved.

@blockarchitech
Copy link
Contributor Author

Thanks @elebumm! I don't see merge conflicts on my phone, can you clarify what you mean?

Thanks!

@callumio
Copy link
Collaborator

callumio commented Jun 5, 2022

@blockarchitech I've solved them for you don't worry. They weren't major ones.

@blockarchitech
Copy link
Contributor Author

Thanks @callumio!

Copy link
Collaborator

@callumio callumio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just that one issue.

setup.py Show resolved Hide resolved
@blockarchitech
Copy link
Contributor Author

alright @callumio how's that?

Copy link
Collaborator

@callumio callumio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant, thank you for this, will really help simplify setup for users :D

@callumio callumio merged commit 6bf4dd8 into elebumm:master Jun 5, 2022
@blockarchitech
Copy link
Contributor Author

Yeah, no problem!

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

Successfully merging this pull request may close these issues.

[Enhancement] TUI Setup Interface
8 participants