Metadata-Version: 2.1
Name: mac-slideshow
Version: 2018.12.10
Summary: MacOS slideshow screensaver
Home-page: https://github.com/looking-for-a-job/mac-slideshow.py
License: UNKNOWN
Keywords: slideshow screensaver
Platform: UNKNOWN
Classifier: License :: Public Domain
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: mac-open
Requires-Dist: pgrep
Requires-Dist: public
Requires-Dist: runcmd
Requires-Dist: setuptools

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

#### Install
```bash
$ [sudo] pip install mac-slideshow
```

#### Classes
`mac_slideshow.Process` - ScreenSaver process object

method|`__doc__`
-|-
`stop()`|stop screensaver

@property|`__doc__`
-|-
`pid`|return screensaver pid
`running`|return True if screensaver is running, else False

#### Functions
function|`__doc__`
-|-
`mac_slideshow.enable()`|enable iLifeSlideshow screensaver
`mac_slideshow.enabled()`|return True if iLifeSlideshow screensaver enabled
`mac_slideshow.pid()`|return ScreenSaverEngine.app pid
`mac_slideshow.restart(path=None)`|restart screensaver and return Process object
`mac_slideshow.start(path=None)`|start screensaver and return Process object
`mac_slideshow.stop()`|stop screensaver
`mac_slideshow.path.read()`|return iLifeSlideShows images folder path
`mac_slideshow.path.write(path)`|write iLifeSlideShows images folder path
`mac_slideshow.preferences.read(key)`|return preferences value
`mac_slideshow.preferences.write(key, value)`|write preferences value
`mac_slideshow.style.read()`|return iLifeSlideShows style
`mac_slideshow.style.write(style)`|write iLifeSlideShows style

#### CLI
usage|`__doc__`
-|-
`python -m mac_slideshow.path [path]`|read/write iLifeSlideShows screensaver path
`python -m mac_slideshow.pid`|print screensaver pid
`python -m mac_slideshow.start [path]`|start iLifeSlideshows screensaver
`python -m mac_slideshow.stop`|stop iLifeSlideshows screensaver
`python -m mac_slideshow.style [style]`|read/write iLifeSlideShows screensaver style

#### Examples
```python
>>> import mac_slideshow
>>> ss = mac_slideshow.start()
>>> ss.pid # or mac_slideshow.pid()
1234
>>> ss.stop()  # or mac_slideshow.stop()
```

set images path and start/restart
```python
>>> ss = mac_slideshow.start("~/Library/Screen Savers/folder")
```

preferences
```python
>>> mac_slideshow.path.write("path/to/images")
>>> mac_slideshow.path.read()
'path/to/images'

>>> mac_slideshow.style.write("Classic")
>>> mac_slideshow.style.read()
'Classic'
```

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

