https://github.com/enkore/i3pystatus

A complete replacement for i3status
https://github.com/enkore/i3pystatus

i3 i3bar i3status python

Last synced: 30 days ago
JSON representation

A complete replacement for i3status

• Host: GitHub
• URL: https://github.com/enkore/i3pystatus
• Owner: enkore
• License: mit
• Created: 2013-02-11T01:01:15.000Z (almost 12 years ago)
• Default Branch: current
• Last Pushed: 2024-05-09T16:22:36.000Z (6 months ago)
• Last Synced: 2024-05-12T00:10:18.012Z (6 months ago)
• Topics: i3, i3bar, i3status, python
• Language: Python
• Homepage: https://i3pystatus.readthedocs.io/
• Size: 1.82 MB
• Stars: 441
• Watchers: 23
• Forks: 189
• Open Issues: 63
• Metadata Files:
  • Readme: README.rst
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
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

`_.

Documentation

-------------

The official documentation is located at https://i3pystatus.readthedocs.io.

The changelog for old releases can be found `here `_.

Contributors

------------

A list of all contributors can be found in `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

`_.

Developer documentation is available in the source code and `here

`_.

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