一个歌词管理和显示网络应用程序和服务器。
lyricscreen的Python项目详细描述
一种可能过火和强大的歌词或诗句管理方式 音乐会或教堂仪式的展示。
魅力拍摄
注意:此项目正在进行大量开发,不建议使用 用于任务关键功能。这里甚至没有变更日志 因为事情一直在变,好吗?!
安装
PIP
你可以通过pypi轻松获得歌词屏幕!你可以看看 package page或使用 pip如下:
pip install lyricscreen
注意:windows用户:第一次运行lyricscreen时 时间,它将尝试符号链接web_client,如果不 您可以在提升的命令提示符下或以管理员身份运行它。所以,当 您第一次运行它(每个用户),您需要从 以管理员身份运行的命令提示符。
吉特
从源代码生成:
- 克隆此回购协议 (git clone https://github.com/lytedev/lyricscreen)
- 移动到目录(cd lyricscreen)
- 运行安装脚本
- make install给*nix的人(我希望)
- Windows用户必须运行以下命令(您需要 从命令提示符运行python的正确路径设置!) python setup.py bdist_msi,然后运行新构建的 dist/lyricscreen-X.X.X.win32.msi安装程序。
注意:windows用户:第一次运行lyricscreen时 时间,它将尝试符号链接web_client,如果不 您可以在提升的命令提示符下或以管理员身份运行它。所以,当 您第一次运行它(每个用户),您需要从 以管理员身份运行的命令提示符。
Windows安装程序
todo:马上就来!我需要通过葡萄酒来实现 Linux并在PYPI更新上实现。目前,请参阅安装 通过git指导如何构建windows安装程序。
基本用法
命令行
如果您通过pip安装了lyricscreen,只要您的PATH 如果配置正确,您应该能够运行lyricscreen 从你的终端。LyricScreen应自动启动并打开 可访问Web控制台的浏览器页。就这么简单!
lyricscreen --help将显示所有命令行标志和选项。
Windows安装
todo:Windows安装用法。现在,你必须 python脚本和这样的设置在您的路径中并遵循命令行 用法。
配置
使用lyricscreen --create-config生成默认配置。它 将告诉您生成的默认配置文件的位置。正常开放 在您喜爱的文本编辑器中的文件,并修改这些值以适合您的 需要。
命令行二进制文件接受指向首选 如果需要多个配置并在 他们经常。
开发
后端
模块包含在lyricscreen目录中。
网络客户端
web客户端位于lyricscreen/http目录中,但是 你需要做一点准备才能做出正确的贡献。它继续运行 lyricscreen/httpserver.py,尽管它能够运行 其他http服务器,如apache或nginx,因为web客户端是 实际上只是一些html文件、样式表和一些 简单的javascript。
要设置为Web客户端提供服务,您需要 安装了以下软件包。
- npmn代码p包m管理器(您需要 node.js已安装)
- gulp流式生成系统(npm install -g gulp)
- bower前端包管理器(npm install -g bower)
完成后,导航到web客户端目录 (lyricscreen/http)并执行以下操作来构建资产。
npm install bower install gulp
你也可以我们egulp watch根据更改持续生成 制造的。如果您使用livereload插件,这也会发送刷新消息 文件更改时重新加载。
强烈建议将开发目录的Web符号链接 默认情况下,LyricScreen目录的客户端通过运行以下命令使用:
ln -s "$PWD/lyricscreen/http" "$HOME/.config/lyricscreen/web_client"
关注点
- 目前实现的安全性为零。任何人都可以 理论上打开他们的浏览器并通过 http服务器和做任何他们想做的事。
- 目前绝对零易用性和用户体验。最终目标是运行 程序,所有的东西都可以从一个 不需要编辑配置或重新启动的界面。见待办事项 名单。
待办事项
- 控制台连接的身份验证信息/系统?
- 想法:运行时,提示或生成管理员密码,需要初始密码 从“控制台”连接进行身份验证。总之应该够好的 任期?
- 默认web管理客户端的更好用户体验
- 更复杂、可选的歌曲格式选项,用于更漂亮的幻灯片 (背景图像?文本对齐?谷歌字体?)
- 播放列表创建/保存/修改/加载/列表/查看
- 歌曲创作/保存/修改/加载/列表/查看
- 总是:更漂亮,组织更好的代码(符合python代码 标准并具有正确格式的docstrings…或docstringsat 全部)
- yaml配置文件作为选项?
- 为Web客户机上的用户提供了一个不错的介绍页