.. _Python: https://python.org/
.. _netifaces: https://pypi.python.org/pypi/netifaces

Quickstart
==========


.. _quickstart-dependencies:

Dependencies
------------

* `Python`_ 2.7 or >= 3.3

* `netifaces`_ **optional**, needed for :class:`pi3bar.plugins.net.NetIFace`

  (install with ``pip install netifaces``)


.. quickstart-installation:

Installation
------------

.. todo:: ``pip install pi3bar``

Clone the repository and install manually::

    $ git clone https://git.m-stelzer.de/knoppo/pi3bar

    $ cd pi3bar/

    $ python setup.py install


.. quickstart-configuration:

Configuration
-------------

Go to your your i3 directory (where your *config* is located)::

    $ cd ~/.i3/

    # or

    $ cd ~/.config/i3/

Create a file called *status.py*  with the following content and customize it to
fit your needs: (See the :ref:`reference` for further information.)

.. code-block:: python

    #! /usr/bin/env python
    from pi3bar.app import Pi3Bar
    from pi3bar.plugins import *


    Pi3Bar(
        IMAPUnread('example.com', 'mail@example.com', on_click={1: 'claws-mail'}),
        NetIFace('eth0', on_click={1: 'wicd-client -n'}),  # requires netifaces
        NetIFace('wlan0', on_click={1: 'wicd-client -n'}),  # requires netifaces
        Disk('/', on_click={1: 'thunar'}),
        Uname(),
        LoadAvg(on_click={1: 'xterm -e htop'}),
        Uptime(),
        Battery(),
        Clock(),
    ).run()



Make your script executable::

    $ chmod +x status.py

Update your *i3 config* file::

    bar {
        status_command ~/.i3/status.py
    }


Reload or restart your i3 (usually *<mod>+R*).