i3pystatus

Go to file

enkore 18d50199ee setting_util.py: extract some common code, reprint choices on input iteration handy if you don't have scrollback, also, good manners, since the choices are always directly above the input prompt, no matter how often you fail to hit a number on the keyboard with your forehead.		2015-06-17 14:05:44 +02:00
docs	Remove shebangs and coding tags	2015-06-17 10:32:10 +02:00
i3pystatus	Remove shebangs and coding tags	2015-06-17 10:32:10 +02:00
tests	Remove shebangs and coding tags	2015-06-17 10:32:10 +02:00
.gitignore	WIP	2015-01-05 19:46:32 +01:00
.travis.yml	Update CI build process	2014-12-01 14:48:42 +01:00
ci-build.sh	Update ci-build.sh	2015-06-06 09:38:50 +02:00
dev-requirements.txt	Enforce pep8 version >= 1.5.7 since 1.5.6 is buggy	2014-12-17 22:09:42 +01:00
MIT-LICENSE	Create package i3pystatus	2013-02-12 01:07:26 +01:00
README.rst	README: (pretty confident it's growing :-)	2015-06-07 20:27:57 +02:00
setting_util.py	setting_util.py: extract some common code, reprint choices on input iteration	2015-06-17 14:05:44 +02:00
setup.py	Added `Update` indicator module with `pacman` and `cower` backends.	2015-06-01 12:55:47 +02:00

README.rst

i3pystatus
==========

.. image:: http://golem.enkore.de/job/i3pystatus-dev/badge/icon
    :target: http://golem.enkore.de/job/i3pystatus-dev/

.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
    :target: https://travis-ci.org/enkore/i3pystatus

i3pystatus is a 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
*  Alastair Houghton
*  Alexis Lahouze
*  Alex Timmermann
*  Andrés Martano
*  Argish42
*  Armin Fisslthaler
*  Arvedui
*  Baptiste Grenier
*  bparmentier
*  Cezary Biele
*  cganas
*  Christopher Ganas
*  Chris Wood
*  David Foucher
*  David Garcia Quintas
*  dubwoc
*  eBrnd
*  enkore (current maintainer)
*  facetoe
*  Frank Tackitt
*  gacekjk
*  Goran Mekić
*  Gordon Schulz
*  Hugo Osvaldo Barrera
*  Iliyas Jorio
*  Jan Oliver Oelerich (former maintainer)
*  Jason Hite
*  Joaquin Ignacio Barotto
*  Jörg Thalheim
*  Josef Gajdusek
*  Júlio Rieger Lucchese
*  Kenneth Lyons
*  krypt-n
*  Lukáš Mandák
*  Łukasz Jędrzejewski
*  Matthias Pronk
*  Matthieu Coudron
*  Matus Telgarsky
*  Michael Schmidt
*  Mikael Knutsson
*  Naglis Jonaitis
*  Pandada8
*  philipdexter
*  Philip Dexter
*  Sergei Turukin
*  siikamiika
*  Simon
*  Simon Legner
*  Stéphane Brunner
*  Talwrii
*  theswitch
*  tomasm
*  Tom X. Tobin
*  tyjak
*  Tyjak
*  Zack Gold

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>`_.

Developer documentation is available in the source code and `here
<http://docs.enkore.de/i3pystatus>`_.

**Patches and pull requests are very welcome :-)**