tobi-wan-kenobi / bumblebee-status

bumblebee-status is a modular, theme-able status line generator for the i3 window manager.
https://bumblebee-status.readthedocs.io/en/main/
MIT License
1.2k stars 229 forks source link

Website for generating configs & dependencies #928

Open tobi-wan-kenobi opened 1 year ago

tobi-wan-kenobi commented 1 year ago

Feature Request

Idea from #922 by @HappyCthulhu

Create a website that allows users to generate configs & lists required dependencies. Bonus points for making the website so that it also works nicely via curl, similar to curl cheat.sh/psql

Sushants-Git commented 6 months ago

Demo :

https://github.com/tobi-wan-kenobi/bumblebee-status/assets/100516354/49ba2a01-907c-45f3-a9fa-5baed7a25bc7

Site : https://bumblebee-status-config-gen.netlify.app/

(At the moment it works for "cpu, date, datetime, debug, disk, error, git, keys, layout, load, memory " )

Hey @tobi-wan-kenobi ,

Have been using bumblebee-status for a long time now and wanted to contribute to the project.

Made this small demo of my interpretation of the website currently works for "cpu, date, datetime, debug, disk, error, git, keys, layout, load, memory ". it generates a config and also shows the required dependencies ( I can also sort them into python and non-python packages ).

Before proceeding, I'd appreciate your feedback.

Would you like for me to make any specific changes? Please let me know your thoughts.

Thanks!

tobi-wan-kenobi commented 6 months ago

This looks awesome, many thanks! I will have to think feedback through in detail, but overall, I like the direction this takes a lot.

Thank you!

Sushants-Git commented 6 months ago

Feel free to take your time, when you have the details sorted let me know!!

Feel free to assign this issue to me.

tobi-wan-kenobi commented 6 months ago

OK, so I guess I am missing something really obvious, but I cannot make a second input appear for a second module (Firefox, Chrome).

But from your video, this looks awesome!

Sushants-Git commented 6 months ago

Can you do "cpu < Press Space > memory < Press Space >" make sure that everything is in lowercase and if the error continues can you send me a small recording of it.

tobi-wan-kenobi commented 6 months ago

Aahhh, that works, I was sure I was missing something. Thanks!

Maybe a hint on the page would be good? ("Modules (space separated):")

I like this a lot in the current form already, my personal suggestions going forward would be:

Not sure how feasible, but anlive preview would be a supercool stretch goal.

But even if you don't change a single thing, this is cool and absolutely deserves to go in the docs.

Thank you!

Sushants-Git commented 6 months ago

Thanks a lot for the kind words,

By a live preview do you mean showing the bumblebee-status itself, that would be a dope side quest on it's own. (Will try to do this after i get all the modules added first)

One more thing do you have any array like data that you use for the docs website bcs. this is how right now i am storing the data ( https://github.com/Sushants-Git/Bumblebee-Status-Config-Gen/blob/main/src/components/data.js ), it will make the things a lot easier if you already have something like this.

Even if you don't that's nothing to worry about, i can always do it manually.

I will continue working on this and will give you an update by 31 Dec 2023.

Thank you!!

Sushants-Git commented 6 months ago

just need to add the ("Modules (space separated):") hint

Link : https://bumblebee-status-config-gen.netlify.app/

let me know your thoughts and feel free to suggest any changes.

Thanks a lot for adding this to the docs.

tobi-wan-kenobi commented 6 months ago

Awesome, many thanks! This is truly great, I added it to the docs already (with attribution, please let menknow if you want something changed)

Sushants-Git commented 6 months ago

Thanks a lot for adding it to the docs.

I am currently adding some more changes to the website, these are just minor changes like :

After i make these changes (will take me about a week) feel free to close this issue

tobi-wan-kenobi commented 6 months ago

Woah, those are great ideas, thanks!

Sushants-Git commented 6 months ago

Added all the above functionalities, let me know if you want me to make any changes.

If there are no more changes to make feel free to close this issue.

ahormann commented 5 months ago

This looks great! I think it would be helpful if it would list ALL required packages. eg. tkinter is currently not listed as dependency for pulsectl. It is not required for the module to work, but for the optional popups.

Furthermore pulsectl is a tricky module, you cannot use it directly, but pulsein and pulseout instead. This is currently not reflected by this website.

And it would be a cherry on top to generate install-commands for required packages for different systems (eg a pacman-command and a pip command). But this would probably require a lot of effort / community work given the amount of different package managers.

Sushants-Git commented 5 months ago

Those are some pretty good suggestions @ahormann.

The config. generation website itself is open source ( https://github.com/Sushants-Git/Bumblebee-Status-Config-Gen ), if you want to add some packages for a specific module you can make changes in src > components > data.js in the modulesData variable and create a pull request.

I will try and figure out a way to make this easier since not everyone wants to create a pull request for making a small change, will try to add something to the website that allows people to request changes and packages to be added like a mini form or something.

Thanks a lot for the suggestions!!