i3pystatus

Go to file

Facetoe 455053d721 Calendar docs (#605 ) * Properly document calendar module. Raised in #604. * Don't require config_path or calendar. Raised in #604.		2017-09-08 15:50:40 +08:00
docs	Calendar docs (#605 )	2017-09-08 15:50:40 +08:00
i3pystatus	Calendar docs (#605 )	2017-09-08 15:50:40 +08:00
tests	Fix bug that prevented module errors being displayed in bar (#586 )	2017-06-16 14:34:24 +07: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	codestyle -E722	2017-02-23 10:55:28 +01: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	Create README.rst	2017-06-12 17:44:00 +02: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 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.
: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/>`_

Changelog
---------

`Located here. <https://i3pystatus.readthedocs.io/en/latest/changelog.html>`_ Note: no further releases are planned. Install it from Git.

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
<https://i3pystatus.readthedocs.io/en/latest/module.html>`_.

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