py3status
py3status is an extensible i3status wrapper written in Python.
Using py3status, you can take control of your i3bar easily by:
- using one of the available modules shipped with py3status
- grouping multiple modules and automatically or manually cycle their display
- writing your own modules and have their output displayed on your bar
- handling click events on your i3bar and play with them in no time
- seeing your clock tick every second whatever your i3status interval
No extra configuration file needed, just install & enjoy!
About
You will love py3status if you're using i3wm (or sway) and are frustrated by the i3status limitations on your i3bar such as:
- you cannot hack into it easily
- you want more than the built-in modules and their limited configuration
- you cannot pipe the result of one of more scripts or commands in your bar easily
Philosophy
- no added configuration file, use the standard i3status.conf
- rely on i3status' strengths and its existing configuration as much as possible
- be extensible, it must be easy for users to add their own stuff/output by writing a simple python class which will be loaded and executed dynamically
- easily allow interactivity with the i3bar
- add some built-in enhancement/transformation of basic i3status modules output
We apply the Zen of py3status to improve this project and encourage everyone to read it!
Documentation
Up-to-date documentation:
- Installation
- Getting started
- Using Modules
- Custom click events
- The py3-cmd command line
- Writing custom modules
- Contributing
Get help or share your ideas on IRC:
- channel #py3status on OFTC
Installation
See the up to date and complete installation instructions for your favorite distribution.
Usage
In your i3 config file, simply switch from i3status to py3status in your status_command:
status_command py3status
Usually you have your own i3status configuration, just point to it:
status_command py3status -c ~/.i3/i3status.conf
Options
You can see the help of py3status by issuing `py3status -h`:
usage: py3status [-h] [-b] [-c FILE] [-d] [-g] [-i PATH] [-l FILE] [-s]
[-t INT] [-m] [-u PATH] [-v] [--wm WINDOW_MANAGER]
The agile, python-powered, i3status wrapper
optional arguments:
-h, --help show this help message and exit
-b, --dbus-notify send notifications via dbus instead of i3-nagbar
(default: False)
-c, --config FILE load config (default: /home/alexys/.i3/i3status.conf)
-d, --debug enable debug logging in syslog and --log-file
(default: False)
-i, --include PATH append additional user-defined module paths (default:
None)
-l, --log-file FILE enable logging to FILE (default: None)
-s, --standalone run py3status without i3status (default: False)
-t, --timeout INT default module cache timeout in seconds (default: 60)
-m, --disable-click-events
disable all click events (default: False)
-u, --i3status PATH specify i3status path (default: /usr/bin/i3status)
-v, --version show py3status version and exit (default: False)
--wm WINDOW_MANAGER specify window manager i3 or sway (default: i3)
Available modules
All modules shipped with py3status are configurable directly from your current i3status.conf!
Check them out to see all the configuration options.
Control from CLI
Just like i3status, you can force an update of your i3bar by sending a SIGUSR1 signal to py3status. Note that this will also send a SIGUSR1 signal to i3status:
killall -USR1 py3status
To refresh individual modules, the py3-cmd utility can be used, e.g:
py3-cmd refresh wifi
1 maintainer
Metadata
1 maintainer
Release files for py3status 3.64
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| py3status-3.64.tar.gz | 278.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py3status-3.64-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 641.6 kB
Release files / py3status-3.64.tar.gz
| Download URL | py3status-3.64.tar.gz |
|---|---|
| Size | 278.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee169fc96ee3abff179383ce028857eac355889f80ceeaace7fd22d49a82aabd
|
|
BLAKE2b-256 checksum How to use checksums |
864624811a39c7d23d049e0d0536ffc8c91bd7668b75597f362d609383a65ff9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 20, 2026.
Transparency logRelease files / py3status-3.64-py3-none-any.whl
| Download URL | py3status-3.64-py3-none-any.whl |
|---|---|
| Size | 363.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fe3c9792e1539ce07a6367283bfc1790852f3c3a33dbf88e58cdf84549decae4
|
|
BLAKE2b-256 checksum How to use checksums |
ef609c7634f738b1aee510cf3b384abfa111f0596a669701fd0f30a55174fe35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 20, 2026.
Transparency log
