i3pystatus

Go to file

Егор fde7b6bb78 Added levels settings to the battery module (#654 ) * Added levels settings to the battery module Specify text for custom levels of the battery charge * Round up charge the same way it is displayed percentage value used to determine text from levels setting should be round up the same way as when it is displayed on the screen		2018-12-03 11:41:02 +00:00
docs	Add Sonos module (#655 )	2018-08-13 17:04:53 +00:00
i3pystatus	Added levels settings to the battery module (#654 )	2018-12-03 11:41:02 +00:00
tests	WIP: Fix pycodestyle errors (#653 )	2018-08-06 13:29:19 +00:00
.gitignore	fixed get_redditor() method	2017-03-13 09:48:15 +01:00
.travis.yml	Update .travis.yml	2015-08-19 20:03:19 +02:00
ci-build.sh	WIP: Fix pycodestyle errors (#653 )	2018-08-06 13:29:19 +00:00
CONTRIBUTORS	add option "freq_divisor" to "network" module, which allows division of Wi-Fi frequency	2017-02-22 15:45:05 +01: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	2018-01-11 11:37:06 +01:00
setting_util.py	Move and ln-s setting_util there	2015-06-17 14:52:37 +02:00
setup.cfg	WIP: Fix pycodestyle errors (#653 )	2018-08-06 13:29:19 +00: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 large collection of status modules compatible with i3bar from the i3 window manager.

:License: MIT
:Python: 3.4+
:Governance: Patches that don't break the build (Travis or docs) are generally just merged. This is a "do-it-yourself" project, so to speak.
:Releases: No further releases are planned. Install it from Git.

Installation
------------

**Supported Python versions**
i3pystatus requires Python 3.4 or newer and is not compatible with
Python 2.x. Some modules require additional dependencies
documented in the docs.

pip3 install git+https://github.com/enkore/i3pystatus.git

Documentation
-------------

`All further user documentation has been moved here. <https://i3pystatus.readthedocs.io/>`_

The changelog for old releases can be found `here. <https://i3pystatus.readthedocs.io/en/latest/changelog.html>`_

Contributors
------------

A list of all contributors can be found in `CONTRIBUTORS <https://github.com/enkore/i3pystatus/blob/master/CONTRIBUTORS>`_, but git likely has more up-to-date information. i3pystatus was initially written by Jan Oliver Oelerich and later ported to Python 3 and mostly rewritten by 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
<https://i3pystatus.readthedocs.io/en/latest/module.html>`_.

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