readme.md: please add screenshots

lasers commented 7 years ago

Please add screenshots. Everybody love screenshots. Somebody are always asking for them.

Helps with splitting information into their own sections.
Helps with acting like informational separator.
Helps with making py3status looks more fancy.
Helps with showing people what they're looking at.
Helps with showing people what they're looking for.
Helps with showing people what we're doing here.
Helps with identifying and fixing minor mishaps. New!

arch_updates

arch_updates-2017-01-15

[+] Displays the number of package updates pending for an Arch Linux installation.

This will display a count of how many 'pacman' updates are waiting to be installed and optionally a count of how many 'aur' updates are also waiting. Configuration parameters: - `cache_timeout` How often we refresh this module in seconds *(default 600)* - `format` Display format to use *(default 'UPD: {pacman}' or 'UPD: {pacman}/{aur}')* - `hide_if_zero` Don't show on bar if True *(default False)* - `include_aur` Set to True to use 'cower' to check for AUR updates *(default False)* Format placeholders: - `{aur}` Number of pending aur updates - `{pacman}` Number of pending pacman updates Requires: - `cower` Needed to display pending 'aur' updates **author** Iain Tatch <iain.tatch@gmail.com> **license** BSD

dpms

dpms-2017-01-15

[+] Activate or deactivate DPMS and screen blanking.

This module allows activation and deactivation of DPMS (Display Power Management Signaling) by clicking on 'DPMS' in the status bar. Configuration parameters: - `format` string to display *(default '{icon}')* - `icon_off` string to display when dpms is disabled *(default 'DPMS')* - `icon_on` string to display when dpms is enabled *(default 'DPMS')* Format placeholders: - `{icon}` display current dpms icon Color options: - `color_on` when dpms is enabled, defaults to color_good - `color_off` when dpms is disabled, defaults to color_bad **author** Andre Doser <dosera AT tf.uni-freiburg.de>

nvidia_temp

nvidia_temp-2017-01-15

[+] Display NVIDIA GPU temperature.

Configuration parameters: - `cache_timeout` how often we refresh this module in seconds *(default 10)* - `format_prefix` a prefix for the output. *(default 'GPU: ')* - `format_units` the temperature units. Will appear at the end. *(default '°C')* - `temp_separator` the separator char between temperatures (only if more than one GPU) *(default '|')* Color options: - `color_bad` Temperature can't be read. - `color_good` Everything is OK. Requires: - `nvidia-smi` **author** jmdana <https://github.com/jmdana> **license** BSD

scratchpad_async

scratchpad_asyc-2017-01-15

[+] Display the amount of windows and indicate urgency hints on scratchpad (async).

Configuration parameters: - `always_show` whether the indicator should be shown if there are no scratchpad windows *(default False)* - `format` string to format the output *(default "{} ⌫")* Requires: - `i3ipc` (https://github.com/acrisci/i3ipc-python) **author** cornerman **license** BSD

scratchpad_counter

scratchpad_counter-2017-01-15

[+] Display the amount of windows in your i3 scratchpad.

Configuration parameters: - `cache_timeout` How often we refresh this module in seconds *(default 5)* - `format` Format of indicator *(default '{counter} ⌫')* - `hide_when_none` Hide indicator when there is no windows *(default False)* Format placeholders: - `{counter}` number of scratchpad windows **author** shadowprince **license** Eclipse Public License

uname

uname-2017-01-15

[+] Display uname information.

Configuration parameters: - `cache_timeout` how often we refresh this module in seconds *(default 3600)* - `format` see placeholders below *(default '{system} {release} {machine}')* Format placeholders: - `{system}` system/OS name, e.g. 'Linux', 'Windows', or 'Java' - `{node}` computer’s network name (may not be fully qualified!) - `{release}` system’s release, e.g. '2.2.0' or 'NT' - `{version}` system’s release version, e.g. '#3 on degas' - `{machine}` machine type, e.g. 'x86_64' - `{processor}` the (real) processor name, e.g. 'amdk6' **author** ultrabug (inspired by ndalliard)

whoami

whoami-2017-01-15

[+] Display the currently logged in user.

Configuration parameters: - `cache_timeout` how often we refresh this module in seconds *(default 1800)* - `format` string to print *(default '{username}')* Format placeholders: - `{username}` display current username Inspired by i3 FAQ: https://faq.i3wm.org/question/1618/add-user-name-to-status-bar.1.html

tobes commented 7 years ago

I think this is a really nice idea, some thoughts.

modules/README.md is auto generated so we need to have something that works with that.
we would need to produce screenshots for modules and keep them updated, and consistent (fonts etc). Some are going to be harder to produce as need specific distros/setups eg fedora_updates /nvidea_temp/wwan_status
can we automate the production? I like automation (maybe we have to 'fake them')
some modules have different outputs in different situations eg mpris, battery_level
some modules do not really have output eg group/frame/rainbow how do we deal with these?
it might be nice to have more than one for some modules eg sysdata and also have the config used
I like the simple style of your examples although maybe they can be thinner with slightly larger text.

I'd say it would also be nice to have an example or two on the main README.md

lasers commented 7 years ago

[1] Static points to img/.png ?
[2] We can be a bit inconsistent, but I agree. Pick a nice font. Use it. Fake some. Move on.
[3] I think we shouldn't focus too much on screenshots. Just get them done and move on. Then we can focus more on correcting modules, adding formats/depreciation stuffs, minor fixes, etc than to worry about accurate screenshots. I can get them done, then we re-visit this idea later.
[4] Fake them. Best not to go for accurate screenshots then.
[5] I need to see what frame is. Multiple screenshots. Tile them.... or or crop and merge them together. (three different py3status shots in one screenshot)
[6] Same for [5].
[7] Thanks. I don't want to use wallpaper because people will ask where the wallpaper came from. Simple color. Simple font too. We'll go with bigger font. This was taken in 800x50. I think it's almost perfect to fit in github's README.md width without too much resizing. Maybe we try 675 × 50 next time to remove too much blank middle part... and/or not focusing on buttons.

Here's just a shot with no font size, no workspace button, and a random wallpaper.

00example_2017-01-15

tobes commented 7 years ago

I'd keep it even simpler

lasers commented 7 years ago

I'd keep it complicated. Rainbow the screenshots. 🌈

00experiment-2017-01-15 01experiment-2017-01-15 03experiment-2017-01-15

This is definitely very nice though. Bigger bar, same height 50px. We try 25 or 30 next.

Drifting off... Best we get back to modules soon...

EDIT: nvidia_temp fixed ; but prints ['60 C'] , imap updated w/ depreciation stuffs.

tobes commented 7 years ago

yeah pretty colours :)

tobes commented 7 years ago

So I had a bit of a play and created a script that makes fakes from actual py3status output.

  DATA = {
      'sys_data': [
          {'color': '#00FF00', 'full_text': 'CPU: 7.07%'},
          {'full_text': ', '},
          {'color': '#FFFF00', 'full_text': 'Mem: 1.98/3.76 GB (52.7  9%)'}
      ],

      'battery_level': {'color': '#FCE94F', 'full_text': u'\u26a1'},

      'uname': {'full_text': u'Linux 4.8.15-300.fc25.x86_64 x86_64'},
  }

It needs a little tweaking (text should be slightly higher etc) but you get the general idea

lasers commented 7 years ago

Pretty colors. :-) I fired up i3wm display using xephyr w/ screen 800x50. Changed the background. Maim to take the screenshot. That way, all screenshots will be consistent. Fix and comment out modules, i3-msg restart. Repeat, repeat, repeat. Long and ugly way. 👍

tobes commented 7 years ago

ok so I had a bit more of a play see https://github.com/tobes/py3status/blob/screenshots/py3status/modules/README.md

basically I've just scraped all the modules that I could run easily with defaults to get some outputs and then used that data to create the screenshots. This means that we can regenerate the screenshots as we need. Because they are now created from static data the images will be identical including the random color so we shouldn't have problems with git etc. It should also be simple to update the outputs to more reasonable settings.

Some of the screenshots need updating to have more reasonable output. Most things like font and sizes are trivial to change.

lasers commented 7 years ago

Ha. You did it. I suspected maybe you were still playing with that.

This will help us with identifying and fixing minor mishaps since I'm already noticing many things right away. They all came out of nowhere. I like how you give background and module same color. I'm making a rough list.

backlight -- default format ought to be '☼ {level}%')
bluetooth -- ought to be corrected. (bad format, etc, and to BT: {name})
bluetooth -- default format ought to be BT: {name}
coin_balance -- (bad connection)
diskdata -- (bits and pieces)
external script (nothing ; fake "hi there. :-)" or "hello world!")
fedora_updates possible extra space somewhere or just not good font.
frame -- more screenshot / multiple takes (?)
group -- more screenshot / multiple takes (?)
hamster (none) it worked. i tested this. can fake it. just a string.
mpd_status (none) it worked. i tested this. can fake it. just a string.
rainbow -- more screenshot / multiple takes (?)
scratchpad_async (none) can fake it. just a string.
scratchpad_counter (none) can fake it. just a string.
github: -- add octocat icon?? (defaults '(CAT) py3status 32/24) ??
static_string (none) -- ; can fake it. just a string. (lol)
taskwarrior (none) -- can fake it. i tested this. just a string.
twitch_streaming: -- looks like you faked this. nice try. pal.
volume_status: -- possible extra space somewhere or just not good font.
window_title -- (bad): nice fake. totally not async.
xrandr -- (accidental extras in there, good example for frame, rainbow, etc)

How do they looks with ubuntu monospace font? (I like that font very much). I really admire your effort. 🥇

tobes commented 7 years ago

So I did a few updates (you may need to refresh the page lots - github has some awful caching issues)

I tried ubuntu mono for variety. I hate the 0 it has. The most important thing is it being a widely available one preferably installed by default on most distros as it becomes a maintainer dependency.

Inconsolata 13

Ubuntu Mono 13

lasers commented 7 years ago

Try 800x50 next. I got confused. 650x50 looks fine in comments. 800x50 looks fine in README.md. Do you need fake strings from missing modules or will you make it work?

tobes commented 7 years ago

I'm happy for updates/extra modules, It should be the default format - excluding modules that make no sense.

here is the current data I'm using

DATA = {
    'backlight': {'full_text': u'\u263c: 100%'},
    'battery_level': {'color': '#FCE94F',
                      'full_text': u'\u26a1'},
    'bitcoin_price': {'full_text': 'btce: 809.40$, btcde: 785.00\xe2\x82\xac'},
    'bluetooth': {'color': '#FF0000',
                  'full_text': u'BT: OFF'},
    'check_tcp': {'color': '#FF0000',
                  'full_text': u'localhost:22 DOWN'},
    'clock': {'full_text': u'Sun 15 Jan 2017 23:27:17 GMT'},
    'coin_balance':
    {'full_text': u"LTC: Connection to 'http://localhost:9332' failed"},
    'deadbeef': {'full_text': ''},
    'diskdata': {'full_text': u'all:  73.7% (    0.0 B/s)'},
    'do_not_disturb': {'color': '#FF0000',
                       'full_text': u'ON'},
    'dpms': {'color': '#FF0000',
             'full_text': u'DPMS'},
    'exchange_rate': {'full_text': u'$1.0617 \xa30.8841 \xa5121.5380'},
    'external_script': {'full_text': 'script output'},
    'fedora_updates': {'color': '#FFFF00',
                       'full_text': u'DNF: 14'},
    'file_status': {'color': '#FF0000',
                    'full_text': 'no path given'},
    'frame': {'full_text': ''},
    'github': {'full_text': u'py3status 34/24'},
    'group': {'full_text': ''},
    'imap': {'full_text': 'N/A'},
    'keyboard_layout': {'full_text': u'gb'},
    'net_iplist':
    {'color': '#00FF00',
     'full_text':
     u'Network: wls1: 192.168.1.3 fe80::f861:44bd:694a:b99c,fe80::6e02:481c:b878:39f0,fe80::3cd8:d056:ace2:4ae2 virbr0: 192.168.122.1'
     },
    'net_rate': {'full_text': ''},
    'online_status': {'color': '#00FF00',
                      'full_text': u'\u25cf'},
    'pingdom': {'full_text': ''},
    'player_control': {'full_text': u'\u25b6'},
    'pomodoro': {'color': '#FF0000',
                 'full_text': u'Pomodoro (1500)'},
    'process_status': {'color': '#FF0000',
                       'full_text': 'no process name given'},
    'rainbow': {'full_text': ''},
    'rate_counter': {'color': '#FF0000',
                     'full_text': u'Time: 0 day 0:00 Cost: 0.13$'},
    'scratchpad_async': {'full_text': ''},
    'screenshot': {'color': '#00FF00',
                   'full_text': 'SHOT'},
    'selinux': {'color': '#00FF00',
                'full_text': u'selinux: enforcing'},
    'spotify': {'color': '#FF0000',
                'full_text': 'Spotify not running'},
    'static_string': {'full_text': 'Hello World!'},
    'sysdata': [{'color': '#00FF00',
                 'full_text': 'CPU: 9.60%'}, {'full_text': ', '},
                {'color': '#FFFF00',
                 'full_text': 'Mem: 1.91/3.76 GB (50.96%)'}],
    'timer': [{'color': '#CCCCCC',
               'full_text': 'Timer '}, {'color': None,
                                        'full_text': '0'}, {'color': '#CCCCCC',
                                                            'full_text': ':'},
              {'color': None,
               'full_text': '01'}, {'color': '#CCCCCC',
                                    'full_text': ':'}, {'color': None,
                                                        'full_text': '00'}],
    'twitch_streaming': {'full_text': 'stream_name missing'},
    'uname': {'full_text': u'Linux 4.8.15-300.fc25.x86_64 x86_64'},
    'volume_status': {'color': '#00FF00',
                      'full_text': u'\u266a: 95%'},
    'weather_yahoo': {'full_text':  u'\u2602 \u2601 \u2601 \u2601'},
    'whatismyip': {'full_text': '184.9.81.0'},
    'whoami': {'full_text': u'username'},
    'wifi': {'color': '#00FF00',
             'full_text': u'W: 54.0 MBit/s 100% Chicken Remixed'},
    'window_title_async': {'full_text': u'wifi.png'},
    'xrandr': {'color': '#00FF00',
               'full_text': u'LVDS1'},
    'xrandr_rotate': {'color': '#00FF00',
                      'full_text': u'V'},
    'xsel': {'full_text': u'selected text'},
}

lasers commented 7 years ago

'scratchpad': {'full_text': '0 ⌫'},
'scratchpad_async': {'full_text': '1 ⌫'},
'hamster': {'full_text': 'No activity'}, // Hamster running w/ no activity
'hamster': {'full_text': 'Watering flowers@Day-to-day (00:10)'}, // Activity running. Real example.
'diskdata': {'full_text': 'all:  34.4% ( 82.0 KiB/s)'}, // we should fix format, remove space.

DPMS should be green. Green is good. (Maybe no green background. Idk. Nah. it's fine).

Pomodoro could be green. Green is good. Positive. (Green when using Pomodoro)
Pomodoro (1500) vs Pomodoro [1483] // Idk. Idc.

'external_script': {'full_text': 'output of uptime?'},

'imap': {'full_text': 'Mail: 36'},
'mpd_status': {'full_text': '[play] Music For Programming - Episode 6 (Compiled by Gods Of The New Age)'},
'clementine': {'full_text': '♫ Music For Programming - Episode 19 (Compiled by Hivemind)'},
'deadbeef': {'full_text': 'deadbeef: error'}, // need to fix this module, I guess.

'window_title': {'full_text': 'ultrabug/py3status: py3status is an extensible i3status wrapper written in python - Firefox'},
'window_title_async': {'full_text': 'py3status/README.md at screenshots · tobes/py3status - Firefox'},
'taskwarrior': {'full_text': '1 Prepare the first draft of the proposal, 2 Buy milk'}, // Real example

tobes commented 7 years ago

Ok I've used most of that some still need the output trimming eg mpd_status

https://github.com/tobes/py3status/blob/screenshots/py3status/modules/README.md

DejaVu Sans Mono 12 width 800

lasers commented 7 years ago

Hi. Second round. The line below displays 888x4 for me. 888 and one fontsize smaller. See how that looks. The height seems okay unless you think it's a bit too tall. I like how they give off colors. Will look at them again.

After typing out, I now think the height looks good. That and the colors really bring out the statuses quite well.

deadbeef:error (in red).
clock: need to explain what `{Local}` shows exactly? Maybe update it to {local}/{date}.
file_status displays ● ? (that's color_good, active / status in action ; we avoid errors)

I now see hamster. Maybe change 00:10 to 00:03 to explain that it has been 3 minutes already... to convery this information better (than what it looks like...)
That's two. It looks good. Do we want to display that in all status? color_good, color_bad, etc?

green Mail: 36, please.
net_iplist got cut off just like songs. (longer width + smaller font)
nvidia_temp... green 'GPU: 62°C' please

process_status: green ●
I think the defaults for process_status should be "{process} ●" --> "irssi ●"
I think the defaults for online_status should be "{online} ●" --> "Online ●"
I think the defaults for file_status should be "{filename} ●" --> "db.lck ●"

Can we make the modules list in Readme better/much smaller? Nobody shouldn't have to scroll down at least three pages. (Ya I know, click on them, but still).

player_control: three screenshots with different icons?
pomodoro: two ss? green 'Pomodoro [1483]'

rainbow: 'two fifty-four' in 7 different colors. heopfully it doesn't looks too bad if it overflows.

scratchpad_counter?
window_title?

gah, i hate screenshot 'SHOT' PR coming up to replace it with (default '📷 Camera {format_filename}')

tobes commented 7 years ago

The line below displays 888x4 for me.

Well you have a far bigger screen than me. Personally I think 800 is on the big size I liked 650

one fontsize smaller.

Not everyone has great eyesight

I like how they give off colors.

I'm pleased with it too, but you were the inspiration

deadbeef:error (in red).

done

clock: need to explain what {Local} shows exactly? Maybe update it to {local}/{date}.

{Local} is documented and follows the other timezones, it is a magic placeholder so {local}/{date} makes no sense

file_status displays ● ? (that's color_good, active / status in action ; we avoid errors)

added it but is easiest if you just provide the output dict/list for modules then they are simple to add also as \u25cf etc not ●

I now see hamster. Maybe change 00:10 to 00:03 to explain that it has been 3 minutes already... to convery this information better (than what it looks like...)

does it make much difference? I don't use the module

That's two. It looks good. Do we want to display that in all status? color_good, color_bad, etc?

we can have more than one for any module. eg it might be nice to show alternative configs but that would need thought on how to display it to the user etc. the README.md and the modules docstrings are very tied to the point that one can generate the other and I want to keep that functionality.

I might look at adding captions in the coloured bit of the screenshots but that will easily become messy/distracting so maybe not.

green Mail: 36, please.

ok

net_iplist got cut off just like songs. (longer width + smaller font)

I've shortened it by removing some ipv6 addresses

nvidia_temp... green 'GPU: 62°C' please

done

process_status: green ● I think the defaults for process_status should be "{process} ●" --> "irssi ●" I think the defaults for online_status should be "{online} ●" --> "Online ●" I think the defaults for file_status should be "{filename} ●" --> "{filename} ●"

added the green. Changing the defaults is just not going to happen. I have a nice way to get around this though but I'm waiting for some of my existing PRs to get closed first. It also involves a custom font so I need to do more research on packaging fonts etc. Also I need to do some more glyphs

Can we make the modules list in Readme better/much smaller? Nobody shouldn't have to scroll down at least three pages. (Ya I know, click on them, but still).

It's all about progress this was it a year ago https://github.com/ultrabug/py3status/blob/2.9/py3status/modules/README.md

but yes improvements can be made. I'd quite like to see sections media players, etc but coming up with sensible ones isn't easy

player_control: three screenshots with different icons?

you provide them I'll add them

pomodoro: two ss? green 'Pomodoro [1483]'

done

rainbow: 'two fifty-four' in 7 different colors. heopfully it doesn't looks too bad if it overflows.

yeah something

scratchpad_counter? window_title?

fixed

gah, i hate screenshot 'SHOT' PR coming up to replace it with (default '📷 Camera ({filename})')

In your dreams ;)

lasers commented 7 years ago

I have 24" 1920x1200. I don't feel it's big enough. :o

I mean {local} or {date}. Sorry about that slash. Was focusing on lowercase
local and couldn't find anything on {Local}. I see what you mean.

No difference. I don't use the module either. It initally was 00:00 (ie not
even a minute yet) and I gave it ten. 3 minutes looks more realistic than 10 (ihmo).
Trying to make it look real and real good... Maybe to try and get people to use
hamster because of this status. ;-)

Adding captions will be messy. I already feel information overload scrolling
around. Could try breaking up things or simplify things more, I guess.

'player_control': {'full_text': u'\u25b6'},
'player_control': {'full_text': u'\u25fc'},
'player_control': {'full_text': u'\u275a\u275a'},

'file_status': {'full_text': u'\u25cf'},
'file_status': {'full_text': u'\u25a0'},
(omit no path given. thats an error and ugly)

hamster....
first img: no activity (default)
second img: water flowering

xrandr
'xrandr': {'full_text': 'LVDS1+DP1'},
'xrandr': {'full_text': 'LVDS1=DP1'},
'xrandr': {'full_text': 'LVDS1'},
'xrandr': {'full_text': 'DPI1'},

'xrandr_rotate': {'full_text': 'H'},
'xrandr_rotate': {'full_text': 'V'},

DO NOT DISTURB ME!!!! ('OFF' by default, green too pls)

lol business_plan_final3a in txt, not docx or whatever.

'whatismyip': {'full_text': '37.48.108.0'},
'whatismyip': {'full_text': 'Russia'},

weather_yahoo script should not crash if no woeid entered.
just print `weather_yahoo: error' instead.
got an exception line 159.

should omit colon for volume_status and backlight. if word, okay. icons, eh.
reason: icon, colon, space, {stat}. we fix it like icon, space, {stat}. better.
reason: icon, colon, space makes space looks too big.

my py3status tells me that i have been watering flowers for almost seven hours.
you think it's dead yet? i will water it some more.

'twitch_streaming': {'full_text': 'lasers is live!'}, (i no twitch)
This is broken. Dunno if we want ss for format_invalid / format_offline on this one.
(looks like the text would be be in green)

'spotify': {'full_text': 'Totes by The River -> 03:32'}, // jk, i made it up.
btw, this format is: "{artist} : {title}"

'spaceapi': {'full_text': 'closed since 16:38'},

selinux should have customizable string options for enforcing, permissive, disabled

rss_aggregator throws an exception on default / empty.
ask raspbeguy for default rss string.

'vnstat': {'full_text': '26.4 mb'},

who made pingdom? no author.

ns_checker crash // exception (valueerror, modulenotfounderror) on default/empty.

'netdata': {'full_text': 'LAN (SEP) T'} // see below, don't forget color
'LAN(Kb):   1.1↓   0.0↑', 'color': '#FF0000'
'T(Mb): 308↓  25↑ 334↕', 'color': '#00FF00'
SEP IS |

'net_rate': {'full_text': 'eno1:  852.2 KiB/s'}, // too much space. should fix. // pick one of either.
'net_rate': {'full_text': 'eno1:   359.2 B/s'}, // too much space, should fix. // pick one of either.

mpris iz broken4me. cannot run it in test mode either.

insync crash on default. red bar. filenotfounderror. ok py3status. calm down.
this... format = '{status} {queued}'
may look like green 'INSYNC 3'
may look like yellow '(something goes here, status messages) 3'
may look like red 'OFFLINE 3'
i cannot test dis.

lasers commented 7 years ago

########### STOP
'dropboxd_status': {'full_text': 'Dropbox: Up to date'}, // Fake, but looks like it.
Don't use spotify if you did. That was garbage lazy fake.

'do_not_disturb': {'full_text': 'OFF'}, (green)
'do_not_disturb': {'full_text': 'ON'}, (red)

'check_tcp': {'full_text': 'localhost: 22 UP'}, (green)
'check_tcp': {'full_text': 'localhost: 22 DOWN'}, (red) // you had this already

'arch_updates': {'full_text': 'UPD: 5'}, (normal color) 
'arch_updates': {'full_text': 'UPD: 15/4'}, (normal color)

tobes commented 7 years ago

you know you can add the colors 'arch_updates': {'full_text': 'UPD: 5', 'color': '#FFFF00'}

lasers commented 7 years ago

rgr. i got dis in the bag now. look. add this too.

'selinux': {'full_text': 'selinux: enforcing', 'color': '#00FF00' },
'selinux': {'full_text': 'selinux: permissive', 'color': '#FFFF00'},
'selinux': {'full_text': 'selinux: disabled', 'color': '#FF0000' },

thx, mate. i can't wait to see the new list. what's left is mostly https stuffs. w/e tho. really. the new list... it's gonna be so sweet. im so stroked for that list... relly. i can't wait to see it. ;__; no rush, pal. please relax. take you time. i iz exhausted rite now. whee.

tobes commented 7 years ago

I've updated the screenshots and also had a play with the details tags

https://github.com/tobes/py3status/blob/screenshots/py3status/modules/README.md

it's nice in some ways but very inaccessible and actually ruins one of my regular uses of the page. Maybe we should have 2 pages rather than just the one.

tobes commented 7 years ago

So I've now got

old style README https://github.com/tobes/py3status/blob/screenshots/py3status/modules/README.md
quickview https://github.com/tobes/py3status/blob/screenshots/doc/modules.md

lasers commented 7 years ago

We got everything obvious with screenshots done. Now, the devil is in the details.

See mprs's description. It overrides the image.

Change it to... ~~Display information from mpris. (??)~~.

I'm wondering if we should remove current, active, and/or the to make all descriptions much shorter/simpler.

net_rate — Display the current network transfer rate. net_rate — Display network transfer rate. (see uname, vnstat for example)

volume_status — Display current sound volume. volume_status — Display sound volume.

wwan_status — Display current network and ip address for newer Huwei modems. wwan_status — Display network and ip address for newer Huwei modems.

etc...

We don't want to make it so verbose. (imho) See xrandr as example. It does not say "Control your current screen(s) layout easily."

taskwarrior — Display currently active (started) taskwarrior tasks. taskwarrior — Display (started) taskwarrior tasks.

pingdom — Display the latest response time of the configured Pingdom checks. latest is basically same as current. pingdom — Display response time of the configured Pingdom checks.

With <details> in place, you have to click the title to expand the content, not the image. I know this. You know this. I don't know if this will a bit confusing for people since they're used to clicking buttons, image buttons, etc. This is somewhat close. Clicking this takes you to github's view image alone. I guess only small number of people. Good example is player_control, pomodoro, process_status.

For most parts, we finished putting together the screenshots. ... minus the missing screenshots and I'm now nitpicking on things so maybe we're done? or keep nitpicking? I'll keep nitpicking. (really. im just trying to shorten all descriptions right now).

spotify — Display information about the current song playing on Spotify. spotify — Display information about the song playing on Spotify.

clementine — Display the current "artist - title" playing in Clementine. clementine — Display information about the song playing in Clementine.

mpris - Display information about the song and video playing in mpris.

rate_counter — Display days/hours/minutes spent and calculate the price of your service. rate_counter — Display time spent and calculate the price of your service.

whatismyip — Display your public/external IP address and toggle to online status on click. whatismyip — Display public/external IP address and online status.

etc... I stop now. Interesting. whatismyip contains online_status too. Maybe we give it last look today and you make a PR. Merge. Close this. :-)

tobes commented 7 years ago

to make all descriptions much shorter/simpler.

yes this is a good idea consistency is good, this needs doing via the model docstrings

With
in place, you have to click the title to expand the content, not the image.

that is github maybe there is an easy way to prevent this

Maybe we give it last look today and you make a PR. Merge.

Soon I hope I need to clean up the code, document stuff make it nice and enforce it on modules to help keep it current etc.

lasers commented 7 years ago

that is github maybe there is an easy way to prevent this

See how I did it in first comment. Non-collapsible title // image(s) // [+] collapsible description with documentation. I think that came out clean.

I could make a PR later on docstrings. Would you update all issues with missing feature request tags and make hold tags so I know the code is okay, but hold for discussion first on strings).

I will revisit all my PRs and see if I can make them better by adding depreciation and remove excess options that can be used by the formatter instead. We can close all issues and PRs. ;-)

tobes commented 7 years ago

I think that came out clean.

clicking the image is still fucked

I will revisit all my PRs and see if I can make them better by adding depreciation and remove excess options that can be used by the formatter instead. We can close all issues and PRs. ;-)

cool I'll try to look at some stuff tomorrow

lasers commented 7 years ago

'bluetooth': {'color': '#00FF00', 'full_text': 'BT: Microsoft Bluetooth Notebook Mouse 5000'},

Typo fix. check_tcp UP. --> localhost:22 UP

No screenshot. aws_bill.
No screenshot. glpi.
No screenshot. gpmdp.
No screenshot. graphite
No screenshot. ns_checker.
No screenshot. rss_aggregator.
No screenshot. rt.

No screenshot. icinga2.
We fake screenshots for icinga2 w/ this.
https://github.com/nazco/i3status-modules

Poor screenshot. coin_balance.
Poor screenshot. deadbeef.
Poor screenshot. pingdom. (show nothing)
Poor screenshot. frame. (show nothing)
Poor screenshot. rainbow. (show nothing)
Poor screenshot. spotify. (spotify not running)

insync -- fake strings is in earlier comment. here. 

insync crash on default. red bar. filenotfounderror. ok py3status. calm down.
this... format = '{status} {queued}'
may look like green 'INSYNC 3'
may look like yellow '(something goes here, status messages) 3'
may look like red 'OFFLINE 3'
i cannot test dis.

kdeconnector: 'Samsung Galaxy S6 ⬆ 94%' (in green).
kdeconnector: 'Samsung Galaxy S6 ⬇ 93%' (in yellow).
kdeconnector: 'Samsung Galaxy S6 ⬇ 92%' (in red).
kdeconnector: 'device disconnected' (in red). // real. smartphone sleeping.
kdeconnector: 'unknown device' (in red)  // default if not configured 

Green if USB connected. I saw red, but I don't know what it's for... 
Also can get this...
{'full_text': 'Samsung Galaxy S6 ✉ ⬆ 97%', 'color': '#00FF00'}

hamster: 00:03. >_> (shows that we're 3 min in w/
watering than undecided ten minutes (is it default or..)

Make screenshots for do_not_disturb, dpms, etc... or on only?
'dpms': {'color': '#FF0000', 'full_text': 'DPMS'},
'dpms': {'color': '#00FF00', 'full_text': 'DPMS'},
'do_not_disturb': {'color': '#00FF00', 'full_text': 'OFF'},
'do_not_disturb': {'color': '#FF0000', 'full_text': 'ON'},

Fake github notification (whole yellow background... adding ' N3' at end)
could fix format to make it possible to display notification alone (if we got one)

Fill in missing netdata and net_rate from my earlier comment. here.
'netdata': {'full_text': 'LAN(Kb):  16.9↓   5.2↑', 'color': '#FF0000'},
(separator)
'netdata': {'full_text': 'T(Mb): 2264↓ 143↑ 2407↕', 'color': '#FF0000}',
both together.

Fill in missing net_rate from my earlier comment. here.
'net_rate': {'full_text': 'eno1:  852.2 KiB/s'},

online_status: add red ■
process_status: add red ■

Looking at vpn_status ... Probably this.
--- 'vpn_status': {'color': '#00FF00', 'full_text': 'VPN: yes'},
--- 'vpn_status': {'color': '#FF0000', 'full_text': 'VPN: no'},

Looking at wwan_status script... Probably this.
--- 'wwan_status': {'color': '#FF0000', 'full_text': 'WWAN: down'},
--- idk about good/on status. 

Looking at yandexdisk_status script... Probably this.
--- 'yandexdisk_status': {'color': '#00FF00', 'full_text': 'Yandex.Disk: Idle'},
--- 'yandexdisk_status': {'color': '#FF0000', 'full_text': 'Yandex.Disk: Not started'},
--- 'yandexdisk_status': {'color': '#FFFF00', 'full_text': 'Yandex.Disk: Busy'},

Better default for backlight, no colon. (we use icon here)
Better default for volume status, no colon (we use icon here).
Fix net_rate to omit extra spaces. eno1:   852.2 KiB/s%
Fix diskdata to omit extra spaces. all:   34.4% (  8.0 KiB/s)

mpd_status have max_width option.
Can add 'by...' or replace w/ 'Compiled' w/ 'Idol Eyes' // real.

lasers commented 7 years ago

@tobes Bump in case you missed the post above. And... 25, 30, 35, 40, 45, 50.

out_noshadow

After a while, I think we should slim down a bit (like you said) to 30 or 35... probably 30? EDIT: And one font smaller? I feel this is still a little too big, but new size should still be big.

tobes commented 7 years ago

Looks much nice with the thinner bar, also maybe you've won me over on the font size

DejaVu Sans Mono 12 DejaVu Sans Mono 11

I still need to do some more work on getting the screenshot info into the modules rather than being separate. But I'll try to push on with this.

lasers commented 7 years ago

Agreed. Much thinner = Much nicer. Let's go with this suit. This looks sharp. 🕶 I like the new screenshots already. Can't get deadbeef to work so I'm faking it for the list.

'deadbeef': {'full_text': 'Music For Programming - Episode 37 (Compiled by Lackluster)%'}, fake/smaller: 'deadbeef': {'full_text': 'Music For Programming - Lackluster)%'},

lasers commented 7 years ago

'gpmdp': '♫ Now Playing: The Show Goes On by Lupe Fiasco'}

tobes commented 7 years ago

I've done a bit of an update - more like your original design

https://github.com/tobes/py3status/blob/screenshots/doc/modules.md

I've reverted the old modules/readme.md as I think it serves a different purpose but that we should point people to the new pretty one.

Anyhow I want to move all the screenshot data into the actual modules (which will be dull) and I still need to make the code usable etc but hopefully this will be ready soon.

tobes commented 7 years ago

I'm closing this as we have #751 and this has all got a bit long to read and is likely outdated now

ultrabug / py3status