i3pystatus

Go to file

Erik Johnson d5082fab73 Fix both broken weather modules (#789 ) * Fix both broken weather modules The Weather.com changed its API again, this fixes that as well as fixing a bug that caused the weather conditions to always show as "None". For Weather Underground, the module had been broken for some time due to the discontinuation of their API. The module has been rewritten to use the same API calls that the website itself uses. * Fix double-click browser launch in wunderground module * Add example of longer location_code for weather.com		2020-08-27 20:49:26 -05:00
docs	Add a new module to display charge status of a Tesla (#762 )	2020-02-13 14:37:53 +01:00
i3pystatus	Fix both broken weather modules (#789 )	2020-08-27 20:49: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	Add a new module to manage Yubikey devices (#785 )	2020-07-23 22:27:50 +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	Add a new module to manage Yubikey devices (#785 )	2020-07-23 22:27:50 +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: use find_packages	2016-11-12 15:42:01 +01:00

README.rst

i3pystatus
==========

.. 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.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 :-)**