Go to file
David Wahlstrom 8b8a3db25c makewatch: Remove "user" setting
While there was documentation suggesting you could limit the search by
user, the code was not written to do such.  This could be implimented in
the future, but for now, I'm just going to remove the comment.
2015-06-06 09:29:18 +02:00
docs makewatch: a module to watch for make (or other long running) jobs 2015-06-06 09:28:42 +02:00
i3pystatus makewatch: Remove "user" setting 2015-06-06 09:29:18 +02:00
tests fix pep8 2015-06-05 17:40:45 +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 Make sure that we use python3 pep8 2014-12-18 18:34:57 +01: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 update list of contributors 2015-06-01 15:55:51 +02:00
setting_util.py Update setting util to locate modules with protected settings in 2015-02-01 09:19:31 +08:00
setup.py Added Update indicator module with pacman and cower backends. 2015-06-01 12:55:47 +02:00

..  Always edit README.tpl.rst. Do not change the module reference manually.

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

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 :-)**