Metadata-Version: 2.1
Name: ubersicht
Version: 2018.11.20
Summary: python + Ubersicht.app (MacOS)
Home-page: https://github.com/looking-for-a-job/ubersicht.py
License: UNKNOWN
Keywords: ubersicht
Platform: UNKNOWN
Classifier: Environment :: MacOS X
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
Requires-Dist: public
Requires-Dist: setuptools

[![](https://img.shields.io/badge/OS-MacOS-blue.svg?longCache=True)]()
[![](https://img.shields.io/pypi/pyversions/ubersicht.svg?longCache=True)](https://pypi.org/pypi/ubersicht/)

#### Install
```bash
$ [sudo] pip install ubersicht
```

#### Classes

###### `ubersicht.Coffee`

index.coffee generator class

attr|default value
-|-
`command`|`echo`
`html`|`None`
`refresh`|`365 days`
`style`|`None`
`update`|`$(domEl).empty().append("#{output}")`

###### `ubersicht.Widget`

widget generator class

method|description
-|-
`create()`|create widget
`rm()`|remove widget (if exists)

#### Functions
function|description
-|-
`ubersicht.kill()`|kill Übersicht.app process
`ubersicht.pid()`|return Übersicht.app pid
`ubersicht.restart()`|restart Übersicht.app
`ubersicht.start()`|open Übersicht.app
`ubersicht.widgets()`|return list with widgets paths

#### Examples
generate widget
```python
>>> import ubersicht
>>> widget = ubersicht.Widget(name="name.widget", command="echo hello world", refresh="1s",style="color: red")
>>> widget.create()
>>> widget.path
'/Users/username/Library/Application Support/Übersicht/widgets/name.widget'
```

```bash
$ cat ~/Library/Application Support/Übersicht/widgets/name.widget/index.coffee
command: "echo hello world"

refreshFrequency: '1s'

update: (output, domEl) ->
    $(domEl).empty().append("#{output}")

style: """
color: red
"""
```

#### Links
+   [Uebersicht.app](https://github.com/felixhageloh/uebersicht)

<p align="center"><a href="https://pypi.org/project/readme-md/">readme-md</a> - README.md generator</p>

