Package: bpytop
IndexNewsDocumentsDescriptionFeaturesThemesSupport and fundingPrerequisites(Read this if you are having issues!)DependenciesScreenshotsInstallationConfigurabilityLicenseNewsC++ Version18 September 2021The Linux version of btop++ is complete. Released as version 1.0.0Get it athttps://github.com/aristocratos/btopThe development plan right now:1.1.0 Mac OsX support1.2.0 FreeBSD support1.3.0 Support for GPU monitoring1.X.0 Other platforms and features...2 May 2021I've started work on the third iteration of bashtop->bpytop.
It's being written in C++ and will simply be calledbtop.I'm aiming at releasing a beta version around August this year and will publish the repo when I've got the core functionality and structure ready for anybody that wanna help out.This project is gonna take some time until it has complete feature parity with bpytop, since all system information gathering will likely have to be written from scratch without any external libraries.
And will need some help in the form of code contributions to get complete support for BSD and OSX.If you got suggestions of C++ libraries that are multi-platform and are as extensive aspsutilare for python, feel free to open up a new thread in Discussions, it could help speed up the development a lot.Will post any updates about this project here until the repo is made available.DocumentsCHANGELOG.mdCONTRIBUTING.mdCODE_OF_CONDUCT.mdDescriptionResource monitor that shows usage and stats for processor, memory, disks, network and processes.Python port and continuation ofbashtop.FeaturesEasy to use, with a game inspired menu system.Full mouse support, all buttons with a highlighted key is clickable and mouse scroll works in process list and menu boxes.Fast and responsive UI with UP, DOWN keys process selection.Function for showing detailed stats for selected process.Ability to filter processes, multiple filters can be entered.Easy switching between sorting options.Send SIGTERM, SIGKILL, SIGINT to selected process.UI menu for changing all config file options.Auto scaling graph for network usage.Shows message in menu if new version is availableShows current read and write speeds for disksThemesBpytop uses the same theme files as bashtop so any theme made for bashtop will work.Seethemesfolder for available themes.Themake installcommand places the default themes in/usr/local/share/bpytop/themes.
If installed withpip3the themes will be located in a folder calledbpytop-themesin the python3 site-packages folder.
User created themes should be placed in$HOME/.config/bpytop/themes.Let me know if you want to contribute with new themes.Support and fundingYou can sponsor this project through github, seemy sponsors pagefor options.Or donate throughpaypalorko-fi.Any support is greatly appreciated!PrerequisitesMac Os XWill not display correctly in the standard terminal (unless truecolor is set to False)!
Recommended alternativeiTerm2Will also need to be run as superuser to display stats for processes not owned by user.OsX on Apple Silicon (arm) requires psutil version 5.8.0 to work and currently has no temperature monitoring.
Upgrade psutil withsudo pip3 install psutil --upgradeLinux, Mac Os X and FreeBSDFor correct display, a terminal with support for:24-bit truecolor (See list of terminals with truecolor support)256-color terminals are supported through 24-bit to 256-color conversion when setting "truecolor" to False in the options or with "-lc/--low-color" argument.Wide characters (Are sometimes problematic in web-based terminals)Also needs a UTF8 locale and a font that covers:Unicode Block “Braille Patterns” U+2800 - U+28FFUnicode Block “Geometric Shapes” U+25A0 - U+25FFUnicode Block "Box Drawing" and "Block Elements" U+2500 - U+259FNotice (Text rendering issues)If you are having problems with the characters in the graphs not looking like they do in the screenshots,
it's likely a problem with your systems configured fallback font not having support for braille characters.SeeTerminess Powerlinefor an example of a font that includes the braille symbols.See comments by @sgleizeslinkand @XenHatlinkin issue #100 for possible solutions.If text are misaligned and you are using Konsole or Yakuake, turning off "Bi-Directional text rendering" is a possible fix.Characters clipping in to each other or text/border misalignments is not bugs caused by bpytop, but most likely a fontconfig or terminal problem where the braille characters making up the graphs aren't rendered correctly.
Look to the creators of the terminal emulator you use to fix these issues if the previous mentioned fixes don't work for you.Notice (SSH)Dropbear seems to not be able to set correct locale. So if accessing bpytop over ssh, OpenSSH is recommended.DependenciesPython3(v3.7 or later)psutil module(v5.7.0 or later)Optionals for additional stats(Optional OSX)coretemp(recommended), orosx-cpu-temp(less accurate) needed to show CPU temperatures.ScreenshotsMain UI showing details for a selected process.Main UI in mini mode.Main menu.Options menu.InstallationI only maintain the PyPi package, so will not take responsibility for issues caused by any other install method!PyPi (will always have latest version)Install or update to latest versionpip3installbpytop--upgradeMac OsXInstall with HomebrewbrewinstallbpytopOptional coretemp (Shows temperatures for cpu cores)brewinstallhacker1024/hacker1024/coretempAlternatively install with MacPortsportinstallbpytopOsX on Apple Silicon (arm) requires psutil version 5.8.0 to work and currently has no temperature monitoring.
Upgrade psutil withsudo pip3 install psutil --upgradeArch LinuxAvailable in the Arch Linux [community] repository asbpytopInstallationsudopacman-SbpytopDebian basedAvailable inofficial Debian repositorysince Debian 11InstallationsudoaptinstallbpytopAvailable for debian/ubuntu fromAzlux's repositoryFreeBSD packageAvailable inFreeBSD portsInstall pre-built packagesudopkginstallbpytopFedora/CentOS 8 packageAvailablein the Fedora andEPEL-8 repository.InstallationsudodnfinstallbpytopGentoo / Calculate LinuxAvailable fromadrien-overlayInstallationsudoemerge-avsys-process/bpytopMageia Cauldron (Mageia 8)Available in Mageia Cauldron and then Mageia 8 when it is released.Installationsudourpmibpytop
sudodnfinstallbpytopMX LinuxAvailable in the MX Test Repo asbpytopPlease use MX Package Installer MX Test Repo tab to install.http://mxrepo.com/mx/testrepo/pool/test/b/bpytop/Void LinuxAvailable in void repo and void-packages ports treeInstallationsudoxbps-installbpytopSnap package(Note! There is some issues caused by the snap sandboxing)by @kz6fittycenthttps://github.com/kz6fittycent/bpytop-snapInstall the packagesudosnapinstallbpytopThe config folder will be located in~/snap/bpytop/current/.config/bpytopManual installationDependencies installation LinuxInstall python3 and git with a package manager of you choiceInstall psutil python module (sudo might be required)python3-mpipinstallpsutilDependencies installation OSXInstall homebrew if not already installed/bin/bash-c"$(curl-fsSLhttps://raw.githubusercontent.com/Homebrew/install/master/install.sh)"Install python3 if not already installedbrewinstallpython3gitInstall psutil python modulepython3-mpipinstallpsutilInstall optional dependency coretemp (recommended), or osx-cpu-temp (less accurate)brewinstallhacker1024/hacker1024/coretempbrewinstallosx-cpu-tempDependencies installation FreeBSDInstall with pkg and pipsudopkginstallgitpython3py37-psutilManual installation Linux, OSX and FreeBSDClone and installgitclonehttps://github.com/aristocratos/bpytop.gitcdbpytop
sudomakeinstallto uninstall itsudomakeuninstallConfigurabilityAll options changeable from within UI.
Config files stored in "$HOME/.config/bpytop" folderbpytop.cfg: (auto generated if not found)"/etc/bpytop.conf" will be used as default seed for config file creation if it exists. ("/usr/local/etc/bpytop.conf" on BSD)#? Config file for bpytop v. 1.0.64#* Color theme, looks for a .theme file in "/usr/[local/]share/bpytop/themes" and "~/.config/bpytop/themes", "Default" for builtin default theme.#* Prefix name by a plus sign (+) for a theme located in user themes folder, i.e. color_theme="+monokai"color_theme="monokai"#* If the theme set background should be shown, set to False if you want terminal background transparencytheme_background=False#* Sets if 24-bit truecolor should be used, will convert 24-bit colors to 256 color (6x6x6 color cube) if false.truecolor=True#* Manually set which boxes to show. Available values are "cpu mem net proc", separate values with whitespace.shown_boxes="cpu mem net proc"#* Update time in milliseconds, increases automatically if set below internal loops processing time, recommended 2000 ms or above for better sample times for graphs.update_ms=2000#* Processes update multiplier, sets how often the process list is updated as a multiplier of "update_ms".#* Set to 2 or higher to greatly decrease bpytop cpu usage. (Only integers)proc_update_mult=2#* Processes sorting, "pid" "program" "arguments" "threads" "user" "memory" "cpu lazy" "cpu responsive",#* "cpu lazy" updates top process over time, "cpu responsive" updates top process directly.proc_sorting="cpu lazy"#* Reverse sorting order, True or False.proc_reversed=False#* Show processes as a treeproc_tree=False#* Which depth the tree view should auto collapse processes attree_depth=3#* Use the cpu graph colors in the process list.proc_colors=True#* Use a darkening gradient in the process list.proc_gradient=True#* If process cpu usage should be of the core it's running on or usage of the total available cpu power.proc_per_core=False#* Show process memory as bytes instead of percentproc_mem_bytes=True#* Sets the CPU stat shown in upper half of the CPU graph, "total" is always available, see:#* https://psutil.readthedocs.io/en/latest/#psutil.cpu_times for attributes available on specific platforms.#* Select from a list of detected attributes from the options menucpu_graph_upper="total"#* Sets the CPU stat shown in lower half of the CPU graph, "total" is always available, see:#* https://psutil.readthedocs.io/en/latest/#psutil.cpu_times for attributes available on specific platforms.#* Select from a list of detected attributes from the options menucpu_graph_lower="total"#* Toggles if the lower CPU graph should be inverted.cpu_invert_lower=True#* Set to True to completely disable the lower CPU graph.cpu_single_graph=False#* Shows the system uptime in the CPU box.show_uptime=True#* Check cpu temperature, needs "osx-cpu-temp" on MacOS X.check_temp=True#* Which sensor to use for cpu temperature, use options menu to select from list of available sensors.cpu_sensor=Auto#* Show temperatures for cpu cores also if check_temp is True and sensors has been foundshow_coretemp=True#* Which temperature scale to use, available values: "celsius", "fahrenheit", "kelvin" and "rankine"temp_scale="celsius"#* Show CPU frequency, can cause slowdowns on certain systems with some versions of psutilshow_cpu_freq=True#* Draw a clock at top of screen, formatting according to strftime, empty string to disable.draw_clock="%H:%M"#* Update main ui in background when menus are showing, set this to false if the menus is flickering too much for comfort.background_update=True#* Custom cpu model name, empty string to disable.custom_cpu_name=""#* Optional filter for shown disks, should be full path of a mountpoint, separate multiple values with a comma ",".#* Begin line with "exclude=" to change to exclude filter, otherwise defaults to "most include" filter. Example: disks_filter="exclude=/boot, /home/user"disks_filter="exclude=/boot"#* Show graphs instead of meters for memory values.mem_graphs=True#* If swap memory should be shown in memory box.show_swap=True#* Show swap as a disk, ignores show_swap value above, inserts itself after first disk.swap_disk=True#* If mem box should be split to also show disks info.show_disks=True#* Filter out non physical disks. Set this to False to include network disks, RAM disks and similar.only_physical=True#* Read disks list from /etc/fstab. This also disables only_physical.use_fstab=True#* Toggles if io stats should be shown in regular disk usage viewshow_io_stat=True#* Toggles io mode for disks, showing only big graphs for disk read/write speeds.io_mode=False#* Set to True to show combined read/write io graphs in io mode.io_graph_combined=False#* Set the top speed for the io graphs in MiB/s (10 by default), use format "device:speed" separate disks with a comma ",".#* Example: "/dev/sda:100, /dev/sdb:20"io_graph_speeds=""#* Set fixed values for network graphs, default "10M" = 10 Mibibytes, possible units "K", "M", "G", append with "bit" for bits instead of bytes, i.e "100mbit"net_download="100Mbit"net_upload="100Mbit"#* Start in network graphs auto rescaling mode, ignores any values set above and rescales down to 10 Kibibytes at the lowest.net_auto=True#* Sync the scaling for download and upload to whichever currently has the highest scalenet_sync=False#* If the network graphs color gradient should scale to bandwidth usage or auto scale, bandwidth usage is based on "net_download" and "net_upload" valuesnet_color_fixed=False#* Starts with the Network Interface specified here.net_iface="br0"#* Show battery stats in top right if battery is presentshow_battery=True#* Show init screen at startup, the init screen is purely cosmeticalshow_init=False#* Enable check for new version from github.com/aristocratos/bpytop at start.update_check=True#* Set loglevel for "~/.config/bpytop/error.log" levels are: "ERROR" "WARNING" "INFO" "DEBUG".#* The level set includes all lower levels, i.e. "DEBUG" will show all logging info.log_level=DEBUGCommand line options:usage: bpytop.py [-h] [-b BOXES] [-lc] [-v] [--debug]

optional arguments:
  -h, --help            show this help message and exit
  -b BOXES, --boxes BOXES
                        which boxes to show at start, example: -b "cpu mem net proc"
  -lc, --low-color      disable truecolor, converts 24-bit colors to 256-color
  -v, --version         show version info and exit
  --debug               start with loglevel set to DEBUG overriding value set in configLICENSEApache License 2.0