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
- Host: GitHub
- URL: https://github.com/tryone144/orangeslices
- Owner: tryone144
- License: mit
- Created: 2016-05-25T19:25:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-20T17:04:31.000Z (almost 9 years ago)
- Last Synced: 2025-02-01T10:28:10.508Z (4 months ago)
- Language: Python
- Size: 31.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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).