search

petereon / beaupy

A Python library of interactive CLI elements you have been looking for
https://petereon.github.io/beaupy/
MIT License
183 stars 13 forks source link

Is Windows supported? #30

Closed MatanRubin closed 1 year ago

MatanRubin commented 1 year ago

Hi, Awesome project - really love how simple the APIs are and how quickly I could create a fairly complex app. Thank you for your work!

I couldn't see any reference to it in the docs, so I thought I'd just ask here - is Windows supported? I'm developing on a Mac but my app targets Windows users as well - can I expect this to work equally well on Windows environments?

Thanks!

petereon commented 1 year ago

Hi, thank you for the kind words, it is much appreciated!

As for the question of OS support, great question, I've never really had a proper look, I'd do well to add that into the documentation.

Anyways, beaupy is tested against all the major platforms but all of the console interaction is mocked. It relies on the dependencies to handle the interaction with the console, namely readchar to handle user input and rich for console printing. As far as I've checked readchar officially tests against Linux and Windows but noting all Unix based systems should probably work^1 (I've just tested against MacOS and had no issues) and rich officially supports all major platforms^2.

To summarize, Windows and Linux are officially supported and all of the other Unix-based operating systems probably work.

That said, I'd still recommend to test against the platform your target audience is going to use.

petereon commented 1 year ago

@MatanRubin, has your question been answered? Can I consider this closed?

MatanRubin commented 1 year ago

Closing this for now. I'll let some beta testers play with my app on Windows soon and will reopen this issue if we find any issues.

Thanks!

petereon commented 1 year ago

Thanks! If you experience any issues, free to open a new issue.