Description:

mybar 0.14

mybar
Craft highly customizable status bars with ease.

Documentation
Find all of mybar’s documentation here.


Introduction
mybar is a code library and command line tool written in Python for making
status bars.
It aims to aid users in creating custom status bars with intuitive
controls that allow for the customization of every element.
$ python -m mybar --template '{uptime} [{cpu_usage}/{cpu_temp}] | {battery}'
Up 4d:14h:19m [CPU 03%/36C] | Bat 100CHG


Install mybar
mybar supports Python 3.12+.
It can be installed from the Python Package Index:
$ python -m pip install mybar


Use mybar in the command line
By default, mybar looks at config files to load its options.
mybar uses the Scuff
language to process data from and write config files.
The default config file location is ~/.config/mybar/mybar.conf
Running the mybar command line tool using your default config file is as simple as:
$ python -m mybar
The first time you run mybar, it will check if you have a config file in the default location:
-- mybar --
The default config file at '/home/me/.config/mybar/mybar.conf' does not exist.
Would you like to make it now? [Y/n] y
Wrote new config file to '/home/me/.config/mybar/mybar.conf'
You can also skip writing a config file and mybar will start running a bar with default
parameters:
Would you like to make it now? [Y/n] n
mymachine|Up 4d:14h:54m|CPU 04%|36C|Mem 3.8G|/:50.8G|Bat 100CHG|wifi|2023-08-01 17:06:04
Note that any options passed to the command on the first run will be written to the new config file.

Command line examples
See the Documentation
for details on all the command line arguments mybar accepts.
Let’s see some examples of how to use mybar from the command line.
--fields/-f Specify which Fields to show:
$ python -m mybar -f hostname disk_usage cpu_temp datetime
mymachine|/:88.3G|43C|2023-08-01 23:18:22
--template/-t Use a custom format template:
$ python -m mybar -t '@{hostname}: ({uptime} | {cpu_usage}, {cpu_temp}) [{datetime}]'
@mymachine: (Up 1d:12h:17m | CPU 02%, 44C) [2023-08-01 23:31:26]
--separator/-s Change the Field separator:
$ python -m mybar -f hostname uptime cpu_usage -s ' ][ '
mymachine ][ Up 1d:12h:11m ][ CPU 00%
--count/-n Run the Bar a specific number of times:
$ python -m mybar -f hostname cpu_usage datetime -n 3 --break-lines
mymachine|CPU 00%|2023-08-01 23:40:26
mymachine|CPU 00%|2023-08-01 23:40:27
mymachine|CPU 00%|2023-08-01 23:40:28
$
--refresh/-r Set the Bar’s refresh rate:
$ python -m mybar -f hostname cpu_usage datetime -n 3 -r 10 --break-lines
mymachine|CPU 00%|2023-11-24 04:25:31
mymachine|CPU 00%|2023-11-24 04:25:41
mymachine|CPU 00%|2023-11-24 04:25:51
$
--icons/-i Set new icons for each Field:
$ python -m mybar -i uptime='⏱️' cpu_temp='🔥' mem_usage='🧠' battery='🔋'
mymachine|⏱️4d:15h:7m|CPU 00%|🔥50C|🧠8.7G|/:80.7G|🔋100CHG|wifi|2023-11-10 17:19:20
--options/-o Set arbitrary options for the bar or any Field:
$ python -m mybar -t 'Time: {datetime}' -o datetime.kwargs.fmt='%H:%M:%S.%f'
Time: 01:19:55.000229
--config/-c Use a specific config file:
$ python -m mybar -c ~/.config/mybar/my_other_config_file.conf



Use mybar in a Python project
>>> import mybar

Python API examples
See the documentation for in-depth Python API usage.
Let’s see some examples of how to use mybar using the Python API.
Get started with some default Fields:
>>> some_default_fields = ['uptime', 'cpu_temp', 'battery', 'datetime']
>>> sep = ' ][ '
>>> using_defaults = mybar.Bar(fields=some_default_fields, separator=sep)
>>> using_defaults
Bar(fields=['uptime', 'cpu_temp', 'battery', ...])
>>> using_defaults.run()
Up 1d:10h:31m ][ 43C ][ Bat 100CHG ][ 2023-08-01 21:43:40
Load a Bar from a config file:
>>> mybar.Bar.from_file('~/mycustombar.conf')
Bar(fields=['hostname', 'custom_field1', 'disk_usage', ...])
Use your own functions to bring your Bar to life:
>>> def database_reader(query: str) -> str:
return read_from_database(query)

>>> my_field = mybar.Field(func=database_reader, kwargs={'query': '...'}, interval=60)
>>> my_field
Field(name='database_reader')
>>> bar = mybar.Bar(fields=[my_field, 'hostname', 'datetime'], refresh_rate=2)
Append new Fields to your Bar, as if it were a list:
>>> bar.fields
(Field(name='database_reader'), Field(name='hostname'), Field(name='datetime'))
>>> bar.append(Field.from_default('uptime'))
Bar(fields=['database_reader', 'hostname', 'datetime', ...])
>>> bar.fields
(Field(name='database_reader'), Field(name='hostname'), Field(name='datetime'), Field(name='uptime'))
To customize mybar to your liking without using the Python API,
you can use config file options
or command line arguments.



Concepts
This section introduces the core concepts that aid in customizing mybar.


Bar
The status bar.




Field
A part of the Bar containing information, often called a “module”
by other status bar frameworks.




Field function
The function a Field runs to determine what it should contain.




Refresh cycle
The time it takes the Bar to run all its Fields and update its contents once.




Refresh rate
How often the Bar updates what it says, in seconds per refresh.




Interval
How often a Field runs its Field function, in seconds per cycle.




Separator
A string that separates one Field from another




Format string
A special string that controls how Fields and their contents are displayed.




Icon
A string appearing with each Field, usually unique to each.

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter