i3pystatus

Go to file

Thiago Kenji Okada 4bade23063 Forcibly update xkblayout module internal state So when the user modifies the layout externally (for example, using setkbmap) the update is correctly reflect in i3pystatus. Fix issue #523.		2017-01-14 17:41:53 -02:00
docs	Refactor redshift module	2017-01-12 00:25:50 -02:00
i3pystatus	Forcibly update xkblayout module internal state	2017-01-14 17:41:53 -02:00
tests	Backlight: add tests	2016-10-29 18:41:05 +03:00
.gitignore	Add docs/_build to .gitignore	2016-03-29 01:14:56 -05:00
.travis.yml	Update .travis.yml	2015-08-19 20:03:19 +02:00
ci-build.sh	Fix pycodestyle's mood swings	2016-11-07 22:15:04 +01:00
CONTRIBUTORS	Add myself to CONTRIBUTORS	2016-03-29 01:14:56 -05:00
dev-requirements.txt	Forced Sphinx version prior to 1.5	2016-12-25 20:58:08 +01:00
MIT-LICENSE	Create package i3pystatus	2013-02-12 01:07:26 +01:00
README.rst	Update README.rst	2015-09-11 00:05:45 -03:00
setting_util.py	Move and ln-s setting_util there	2015-06-17 14:52:37 +02:00
setup.py	setup.py: use find_packages	2016-11-12 15:42:01 +01: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
------------

A list of all contributors can be found in `CONTRIBUTORS <https://github.com/enkore/i3pystatus/blob/master/CONTRIBUTORS>`_.
Particular noteworthy contributors are former maintainer Jan Oliver Oelerich and
current maintainer enkore.

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