masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,853 Commits 1 Branch 0 Tags 2.3 MiB
Python 99.9%
Shell 0.1%
b8d872f8e5
Go to file
enkore b8d872f8e5
ticker: fix "non-required setting(s) <symbol> with no default!"
2022-01-02 18:21:23 +01:00
docs fix docs build failing 2022-01-02 18:19:21 +01:00
i3pystatus ticker: fix "non-required setting(s) <symbol> with no default!" 2022-01-02 18:21:23 +01:00
tests Adding new hassio modulue (#808) 2021-11-22 06:50:18 -07: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 Fix travis builds (#817) 2021-04-29 22:13:11 -05:00
CONTRIBUTORS mpd: add option "time_format" to module 2021-06-20 15:56:11 +00: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 Improve Documentation (#835) 2022-01-02 11:05:52 -06: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 Fix travis builds (#817) 2021-04-29 22:13:11 -05: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
------------

i3pystatus requires Python 3.6 or newer and is not compatible with Python 2.
Some modules require additional dependencies documented in the docs.

Detailed installation instructions can be found `here
<https://i3pystatus.readthedocs.io/en/latest/installation.html>`_.

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

The official documentation is located at 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
module's 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 :-)**