https://github.com/cdown/osmo
Digital signage for minimalists.
https://github.com/cdown/osmo
Last synced: about 2 months ago
JSON representation
Digital signage for minimalists.
- Host: GitHub
- URL: https://github.com/cdown/osmo
- Owner: cdown
- License: other
- Created: 2013-05-10T19:28:37.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-06-01T02:53:55.000Z (almost 8 years ago)
- Last Synced: 2025-02-26T18:23:46.125Z (2 months ago)
- Language: JavaScript
- Size: 226 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Build status][travis-image]][travis-builds]
[![Coverage][coveralls-image]][coveralls]
[![Code quality][scrutinizer-image]][scrutinizer]
[![Dependencies][requires-image]][requires]
[travis-builds]: https://travis-ci.org/cdown/osmo
[travis-image]: https://img.shields.io/travis/cdown/osmo/master.svg
[coveralls]: https://coveralls.io/r/cdown/osmo
[coveralls-image]: https://img.shields.io/coveralls/cdown/osmo/master.svg
[scrutinizer]: https://scrutinizer-ci.com/g/cdown/osmo/code-structure/master/hot-spots
[scrutinizer-image]: https://img.shields.io/scrutinizer/g/cdown/osmo.svg
[requires]: https://requires.io/github/cdown/osmo/requirements/?branch=master
[requires-image]: https://img.shields.io/requires/github/cdown/osmo.svg
osmo is a digital signage framework for minimalists. It doesn't provide you
with anything fancy, just a web interface to upload images to display, and a
client to display them with.
The client can run anywhere there is a web browser that supports SSE -- it
doesn't require any installation.
## Running
For now, take a look at [tests/run][], but in essence:
- Run the publisher (publisher.py)
- Run the admin interface (admin.py, optional, for adding slides)
- Run the SSE application (client.py)
- Point your browser at wherever you're serving the client.
You'll want to use gunicorn or another multithreaded server if you plan on
having more than one client.
Note that for PDF upload, you will need [ImageMagick][] installed.
[tests/run]: https://github.com/cdown/osmo/blob/master/tests/run
[ImageMagick]: http://www.imagemagick.org/
## Redis
Since all critical multi-stage operations are done in a pipeline, it's pretty
hard to make the database become inconsistent, so you shouldn't worry too much
about that.
The only real thing to worry about is that Redis data is flushed to disk often
enough to not worry about it. My recommendations would to use an AOF redo log,
and persist to disk every few minutes (and configure it to snapshot every now
and then in case someone clears the DB because they have a vendetta against
your slides).
## Testing
Redis must be installed.
$ pip install -r requirements.txt
$ pip install -r tests/requirements.txt
$ tests/run
## License
osmo is MIT licensed. See [the LICENSE file][] for full details.
[the LICENSE file]: (https://github.com/cdown/osmo/blob/master/LICENSE)