1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
Metadata-Version: 2.4
Name: py3status
Version: 3.63
Summary: py3status: an extensible i3status wrapper written in python
Project-URL: Download, https://github.com/ultrabug/py3status/tags
Project-URL: Homepage, https://github.com/ultrabug/py3status
Author-email: Ultrabug <ultrabug@ultrabug.net>
License-Expression: BSD-2-Clause
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Requires-Dist: setuptools; python_version >= '3.12'
Provides-Extra: dbus
Requires-Dist: dbus-python==1.3.2; extra == 'dbus'
Requires-Dist: pygobject==3.46.0; extra == 'dbus'
Provides-Extra: udev
Requires-Dist: pyudev>=0.21.0; extra == 'udev'
Description-Content-Type: text/markdown
# 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](https://ultrabug.github.io/py3status/user-guide/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](https://i3wm.org)
(or [sway](https://swaywm.org)) and are frustrated by the i3status
[limitations](https://faq.i3wm.org/question/459/external-scriptsprograms-in-i3status-without-loosing-colors/) 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](https://ultrabug.github.io/py3status/dev-guide/contributing/#zen-of-py3status) to improve this project and encourage everyone to read it!
## Documentation
Up-to-date [documentation](https://ultrabug.github.io/py3status/):
- [Installation](https://ultrabug.github.io/py3status/user-guide/installation/)
- [Getting started](https://ultrabug.github.io/py3status/getting-started/)
- [Using Modules](https://ultrabug.github.io/py3status/user-guide/configuration/#loading-and-ordering-py3status-modules)
- [Custom click events](https://ultrabug.github.io/py3status/user-guide/configuration/#custom-click-events)
- [The py3-cmd command line](https://ultrabug.github.io/py3status/user-guide/remote-control/)
- [Writing custom modules](https://ultrabug.github.io/py3status/dev-guide/writing-modules/)
- [Contributing](https://ultrabug.github.io/py3status/dev-guide/contributing/)
Get help or share your ideas on IRC:
- channel **\#py3status** on **OFTC**
## Installation
See the up to date and complete [installation instructions](https://ultrabug.github.io/py3status/user-guide/installation/) 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](https://ultrabug.github.io/py3status/user-guide/modules/)
shipped with py3status are [configurable directly from your current i3status.conf](https://ultrabug.github.io/py3status/user-guide/configuration/#loading-and-ordering-py3status-modules)!
[Check them out](https://ultrabug.github.io/py3status/user-guide/modules/)
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](https://ultrabug.github.io/py3status/user-guide/remote-control/)
utility can be used, e.g:
py3-cmd refresh wifi
|
