Metadata-Version: 1.1
Name: lyricscreen
Version: 0.6.2
Summary: A lyrics management and display web app and server.
Home-page: https://github.com/lytedev/lyricscreen
Author: Daniel "lytedev" Flanagan
Author-email: daniel@lytedev.io
License: MIT
Description: LyricScreen
        ===========
        
        A probably-overkill and powerful way of managing lyrics or verse
        displays for concerts or church services.
        
        **NOTE**: This project is under heavy development and is not recommended
        for mission-critical functions. There isn't even a changelog at this
        point since stuff is changing all the time, ok?!
        
        Installation
        ------------
        
        pip
        ~~~
        
        You can get LyricScreen easily through PyPI! You can check out the
        `package page <https://pypi.python.org/pypi/lyricscreen>`__ or use
        ```pip`` <https://pip.pypa.io/en/stable/>`__ as follows:
        
        .. code:: bash
        
            pip install lyricscreen
        
        Git
        ~~~
        
        You'll need the following dependencies:
        
        -  Pandoc (``pacaur -S pandoc-static``)
        -  ``pypandoc`` (``pip install pypandoc``)
        
        To build from source:
        
        -  Clone this repo
           (``git clone https://github.com/lytedev/lyricscreen``)
        -  Run the install script (``make install``)
        
        Windows Installer
        ~~~~~~~~~~~~~~~~~
        
        **TODO**: Coming soon!
        
        Basic Usage
        -----------
        
        Command Line
        ~~~~~~~~~~~~
        
        If you installed LyricScreen through ``pip``, as long as your ``PATH``
        is properly configured, you should be able to just run ``lyricscreen``
        from your terminal. LyricScreen should automatically fire up and open a
        browser page with access to the web console. It's that simple!
        
        Windows Installation
        ~~~~~~~~~~~~~~~~~~~~
        
        **TODO**: Windows installation usage
        
        Development
        -----------
        
        Backend
        ~~~~~~~
        
        The module is contained in the ``lyricscreen`` directory.
        
        Web Client
        ~~~~~~~~~~
        
        The web client is found in the ``lyricscreen/http`` directory, but
        you'll need to do a bit of setup to contribute properly. It runs on
        ``lyricscreen/httpserver.py``, though it's capable of running through
        other HTTP servers such as Apache or nginx, since the web client is
        really just some html files, stylesheets, and some fairly
        straightforward JavaScript.
        
        To get setup for contributing to the Web Client, you'll need the
        following packages installed.
        
        -  ``npm`` **N**\ ode **P**\ ackage **M**\ anager (You'll need
           ``node.js`` installed)
        -  ``gulp`` Streaming build system (``npm install -g gulp``)
        -  ``bower`` Front-end package manager (``npm install -g bower``)
        
        Once that's done, navigate to the web client directory
        (``lyricscreen/http``) and do the following to build the assets.
        
        .. code:: bash
        
            npm install
            bower install
            gulp
        
        You can also use ``gulp watch`` to continually build as changes are
        made. If you use a LiveReload plugin, this also sends refresh messages
        on file changes for a reload.
        
        It's highly recommended to symlink the development directory's web
        client to the directory LyricScreen uses by default by running this:
        
        ::
        
            ln -s "$PWD/lyricscreen/http" "$HOME/.config/lyricscreen/web_client"
        
        Concerns
        --------
        
        -  There is zero security currently implemented. Anyone could
           theoretically open up their browser and open a console through your
           http server and do whatever they want.
        -  Currently absolutely zero ease-of-use and UX. Eventual goal is run
           the program and have everything pre configured and managable from one
           interface without needing to edit configs or restart stuff. See TODO
           list.
        
        TODO
        ----
        
        -  Authentication info/system for console connections?
        -  Idea: on-run, prompt or generate an admin password, require initial
           auth from "console" connections. Should be fine enough for short
           term?
        -  Better UX for default web admin client
        -  More complex, optional song formatting options for fancier slides
           (background images? text-align? Google fonts?)
        -  Playlist creation/saving/modification/loading/listing/viewing
        -  Song creation/saving/modification/loading/listing/viewing
        -  Always: prettier, better organized code (conform to Python code
           standards and have properly formatted docstrings... or docstrings *at
           all*)
        -  YAML config files as an option?
        -  Nice introduction page for users on web client
        
Keywords: lyrics lyric display presentation project projector
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Religion
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Communications
Classifier: Topic :: Communications :: Conferencing
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Multimedia :: Graphics :: Viewers
Classifier: Topic :: Religion
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
