A complete replacement for i3status
Project description
.. Always edit README.tpl.rst. Do not change the module reference manually.
i3pystatus
==========
.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
:target: https://travis-ci.org/enkore/i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager.
Installation
------------
.. note:: Supported Python versions
i3pystatus requires Python 3.2 or newer and is not compatible with
Python 2.x. Some modules require additional dependencies
documented in the docs.
From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
::
pip install i3pystatus
Packages for your OS
++++++++++++++++++++
* `Arch Linux <https://aur.archlinux.org/packages/i3pystatus/>`_ (stable
release)
* `Arch Linux <https://aur.archlinux.org/packages/i3pystatus-git/>`_ (latest
version)
Documentation
-------------
`All further user documentation has been moved here. <http://docs.enkore.de/i3pystatus>`_
Changelog
---------
`Located here. <http://docs.enkore.de/i3pystatus/changelog.html>`_
Contributors
------------
* aaron-lebo
* afics
* al45tair
* Argish42
* Arvedui
* atalax
* bparmentier
* cganas
* crwood
* dubwoc
* enkore (current maintainer)
* facetoe
* gwarf
* hobarrera
* janoliver (former maintainer)
* jasonmhite
* jedrz
* jorio
* kageurufu
* mekanix
* Mic92
* micha-a-schmidt
* naglis
* philipdexter
* rampage644
* sbrunner
* siikamiika
* simon04
* talwrii
* teto
* tomkenmag
* tomxtobin
* tony
* xals
* yemu
* zzatkin
Contribute
----------
To contribute a module, make sure it uses one of the Module classes. Most modules
use IntervalModule, which just calls a function repeatedly in a specified interval.
The output attribute should be set to a dictionary which represents your modules output,
the protocol is documented `here <http://i3wm.org/docs/i3bar-protocol.html>`_.
To update this readme run ``python -m i3pystatus.mkdocs`` in the
repository root and you're done :)
Developer documentation is available in the source code and `here
<http://i3pystatus.readthedocs.org/en/latest/>`_.
**Patches and pull requests are very welcome :-)**
i3pystatus
==========
.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
:target: https://travis-ci.org/enkore/i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager.
Installation
------------
.. note:: Supported Python versions
i3pystatus requires Python 3.2 or newer and is not compatible with
Python 2.x. Some modules require additional dependencies
documented in the docs.
From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
::
pip install i3pystatus
Packages for your OS
++++++++++++++++++++
* `Arch Linux <https://aur.archlinux.org/packages/i3pystatus/>`_ (stable
release)
* `Arch Linux <https://aur.archlinux.org/packages/i3pystatus-git/>`_ (latest
version)
Documentation
-------------
`All further user documentation has been moved here. <http://docs.enkore.de/i3pystatus>`_
Changelog
---------
`Located here. <http://docs.enkore.de/i3pystatus/changelog.html>`_
Contributors
------------
* aaron-lebo
* afics
* al45tair
* Argish42
* Arvedui
* atalax
* bparmentier
* cganas
* crwood
* dubwoc
* enkore (current maintainer)
* facetoe
* gwarf
* hobarrera
* janoliver (former maintainer)
* jasonmhite
* jedrz
* jorio
* kageurufu
* mekanix
* Mic92
* micha-a-schmidt
* naglis
* philipdexter
* rampage644
* sbrunner
* siikamiika
* simon04
* talwrii
* teto
* tomkenmag
* tomxtobin
* tony
* xals
* yemu
* zzatkin
Contribute
----------
To contribute a module, make sure it uses one of the Module classes. Most modules
use IntervalModule, which just calls a function repeatedly in a specified interval.
The output attribute should be set to a dictionary which represents your modules output,
the protocol is documented `here <http://i3wm.org/docs/i3bar-protocol.html>`_.
To update this readme run ``python -m i3pystatus.mkdocs`` in the
repository root and you're done :)
Developer documentation is available in the source code and `here
<http://i3pystatus.readthedocs.org/en/latest/>`_.
**Patches and pull requests are very welcome :-)**
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
i3pystatus-3.32.tar.gz
(42.9 kB
view hashes)
