i3pystatus

Go to file

David Wahlstrom e27c0421b7 test_lastfm: pep8 compliance		2016-03-17 19:59:02 -07:00
docs	Merge pull request #320 from facetoe/docs	2016-02-15 11:59:49 +01:00
i3pystatus	last.fm: initial commit of last.fm module	2016-03-16 16:27:02 -07:00
tests	test_lastfm: pep8 compliance	2016-03-17 19:59:02 -07:00
.gitignore	WIP	2015-01-05 19:46:32 +01:00
.travis.yml	Update .travis.yml	2015-08-19 20:03:19 +02:00
ci-build.sh	Decrease chattiness of ci-build.sh; error reporting is not reduced	2016-02-08 10:10:28 +01:00
CONTRIBUTORS	Total rewrite into an IntervalModule, how it should have been. Added {status}, format_not_running, color_not_running, and comments to make it readable. This improvement was loosely based on the cmus module	2015-09-13 16:59:22 -04: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 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	3.34	2016-02-14 01:18:39 +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 :-)**