thiagokokada / i3pyblocks

A replacement for i3status, written in Python using asyncio.
MIT License
19 stars 2 forks source link
asyncio i3status i3wm python python3 swaywm

i3pyblocks

PyPI version Test Lint Documentation Status Codecov

Screenshot

A replacement for i3status, written in Python using asyncio.

Works in both i3wm and sway.

For Python 3.7+.

Installation and Usage

Look at the example.py file for inspiration and check the User guide section of documentation.

Development

To setup a development environment, create a new venv first and run:

make dev-install

To run the tests, you may run:

make test

Look at the included Makefile for more available commands.

If you're using NixOS or nixpkgs, an alternative way to get a working environment variable is using the shell.nix file included in this repo:

nix-shell shell-dev.nix

For more information, look at Creating a new block section of documentation.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT