i3pystatus

Go to file

Erik Johnson 3bc23608fd Update Weather Underground weather backend to reflect API change (#816 ) * Update Weather Underground weather backend to reflect API change Also change weather backends to use f-strings instead of percent-replacement in log messages, now that i3pystatus is Python 3.6+. * Address pycodestyle failure * Remove outdated config items		2021-04-29 21:48:26 -05:00
docs	docs: update copyright year	2020-09-07 16:51:18 +02:00
i3pystatus	Update Weather Underground weather backend to reflect API change (#816 )	2021-04-29 21:48:26 -05:00
tests	added absolute value to handle negative CURRENT_NOW & test case (#730 )	2019-04-23 00:51:52 +10:00
.gitignore	ignore venv files	2019-04-23 20:30:56 +10:00
.travis.yml	Travis-ci: added support for ppc64le	2020-10-21 17:37:21 +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	README: add rtfd badge	2020-09-07 16:52:44 +02: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: -Python 3.5 +Python 3.8	2020-09-06 18:39:50 +02:00

README.rst

i3pystatus
==========

.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
:target: https://travis-ci.org/enkore/i3pystatus

.. image:: https://readthedocs.org/projects/i3pystatus/badge/?version=latest
:target: https://i3pystatus.readthedocs.io/en/latest/?badge=latest

i3pystatus is a large collection of status modules compatible with i3bar from the i3 window manager.

:License: MIT
:Python: 3.6+
: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.6 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 :-)**