37542f4c30
git log | awk '$1 == "Author:" { print "* ", substr($0, length($1) + 2, length($0) - length($1) - length($NF) - 2) }' | sort | uniq
126 lines
2.9 KiB
ReStructuredText
126 lines
2.9 KiB
ReStructuredText
.. 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 :-)**
|