Welcome to i3pyblocks’s documentation!

i3pyblocks is a replacement for i3status, written in Python using asyncio.

Works in both i3wm and sway.

Highlights

• Fully asynchronous architecture, there is no polling in core (not even to update the i3bar!)

• Most blocks are implemented in a very efficient way, based on events (i.e.: D-Bus, inotify) instead of polling

• Flexible API allowing for full customization. You can even completely override some methods for you own needs if you want

• Modern Python 3.7+ codebase fully type annotated, thanks to mypy

Contents:

• Why another i3status replacement?
• User guide
  • Installation
  • Configuring your i3pyblocks
  • Customizing blocks
  • Using Pango markup
  • Clicks and signals
• Creating a new block
  • Development setup
  • Let’s start with a “Hello World!”
  • A more advanced example
  • Customizing output
  • Clicks and signals
  • When to use each base block?
  • Handling dependencies
  • Collaborating
• API Reference
  • i3pyblocks