An open API service indexing awesome lists of open source software.

https://github.com/tryone144/orangeslices

Statusline generator for https://github.com/lemonboy/bar
https://github.com/tryone144/orangeslices

Last synced: 2 months ago
JSON representation

Statusline generator for https://github.com/lemonboy/bar

Awesome Lists containing this project

README

        

# OrangeSlices (WIP)

__WARNING: WORK IN PROGRESS__ It may kill your cat!

OrangeSlices is a python package/module to generate a statusline with
[LemonBar](https://github.com/LemonBoy/bar).

## Usage

Write a python script which loads the `orangeslices` package:

```python
import orangeslices as osl
```

Instatiate the `orangeslices.Orange` object and add the slices you want from `orangeslices.slices`:

```python
orange = osl.Orange()

clock = osl.slices.Clock()
orange.add(clock)
```

After that you call the `run()` method of your `orangeslices.Orange` to start LemonBar:

```python
orange.run()
```

See the [Examples](./examples) for a basic overview of the procedure. Or take a look at the
[`orangeslices`](./orangeslices) and [`orangeslices.slices`](./orangeslices/slices) API documentation.

## Installation

Clone this repo

```bash
$ git clone https://github.com/tryone144/orangeslices
```

and install with

```bash
$ make
$ make install
```

or with `setuptools`

```bash
$ ./setup.py build
$ ./setup.py install
```

Installation may require root privileges.

## Examples

__# TODO__

## TODO

- Add click handler to the slices

- Build and upload PyPi package

- Improve documentation

- Add more slices:

- UPower

- NetworkManager

- Volume (PulseAudio / ALSA)

- BSPWM Workspaces

## License

© 2016 Bernd Busse

OrangeSlices is licensed under the MIT license. For more information check [LICENSE](./LICENSE).