Skip to main content

py3status is an extensible i3status wrapper written in python

Project description

=========
py3status
=========
**py3status** is an extensible i3status wrapper written in python.

Using py3status, you can take control of your i3bar easily by:
- 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 !

Documentation
=============
See the wiki for up to date documentation:
https://github.com/ultrabug/py3status/wiki

Learn how to write your own modules:
https://github.com/ultrabug/py3status/wiki/Write-your-own-modules

Get help or share your ideas on IRC:
channel **#py3status** on **FreeNode**

Requirements
============
You **must** set the `output_format` to `i3bar` in the general section of your i3status.conf:
::
general {
colors = true
interval = 5
output_format = "i3bar"
}

Installation (all users)
========================
py3status is available on pypi:
::
$ pip install py3status

Installation (Gentoo users)
===========================
py3status is available on portage:
::
$ sudo emerge -a py3status

Installation (Arch users)
=========================
Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL:
::
https://aur.archlinux.org/packages/py3status-git/

Usage
=====
In your i3 config file, simply change the `status_command` with:
::
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`:
::
-c I3STATUS_CONF path to i3status config file
--debug be verbose in syslog
-i INCLUDE_PATHS include user-written modules from those directories
(default .i3/py3status)
-n INTERVAL update interval in seconds (default 1 sec)
-t CACHE_TIMEOUT default injection cache timeout in seconds
(default 60 sec)

Control
=======
Just like i3status, you can force an update by sending a SIGUSR1 signal to py3status.
Note that this will also send a SIGUSR1 signal to i3status.
::
killall -USR1 py3status

Project details


Release history Release notifications

History Node

3.10

History Node

3.9

History Node

3.8

History Node

3.7

History Node

3.6

History Node

3.5

History Node

3.4

History Node

3.3

History Node

3.2

History Node

3.1

History Node

3.0

History Node

2.9

History Node

2.8

History Node

2.7

History Node

2.6

History Node

2.5

History Node

2.4

History Node

2.3

History Node

2.2

History Node

2.1

History Node

2.0

History Node

1.6

History Node

1.5

This version
History Node

1.3

History Node

1.2

History Node

1.1

History Node

1.0

History Node

0.13

History Node

0.12

History Node

0.11

History Node

0.10

History Node

0.9.1

History Node

0.9

History Node

0.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
py3status-1.3.tar.gz (19.0 kB) Copy SHA256 hash SHA256 Source None Feb 23, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page