merge conflicts

.gitignore

@@ -24,4 +24,7 @@ tmp.py
 /data/www/plugins/*
 !/data/www/plugins/.gitkeep
 /var/run/storage/*
-!/var/run/storage/.gitkeep
+!/var/run/storage/.gitkeep
+*.egg-info
+/build/
+/dist/

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+docs/setup-run-on-rpi.md
+docs/setup-run-headless.md

README.md

@@ -71,6 +71,13 @@ Add Content Modal:
 
 If you value this project, please think about awarding it a ⭐. Thanks ! 🙏
 
+## 🗺️ Short-term roadmap
+- New `Composition` content type: Check out a [video demo here](https://demo.obscreen.io/data/uploads/compositions.mp4)
+- New `Text` Content Type: Display text with customizable styles, including options for scrolling effects.
+- New `HTML` Content Type: Display HTML snippets for more powerful text customization, giving you full control over the content.
+- Fleet Studio Management: Reviving a legacy feature
+- Remote Player Server: A new way to manage a player from the studio without needing SSH access to player
+
 ## 🛟 Discussion / Need help ?
 
 ### Join our Discord

docs/setup-run-headless.md

@@ -62,10 +62,20 @@ docker compose up --detach --pull=always
 #### Install
 - Install studio by executing following script
 
+##### Linux
 ```bash
 curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install-studio.sh -o /tmp/install-studio.sh && chmod +x /tmp/install-studio.sh && sudo /bin/bash /tmp/install-studio.sh $USER $HOME
 sudo reboot
 ```
+##### Windows & MacOS
+```bash
+git clone https://github.com/jr-k/obscreen.git
+cd obscreen
+python3 -m venv venv
+source ./venv/bin/activate
+pip install .
+cp .env.dist .env
+```
 
 #### Configure
 - Server configuration is editable in `.env` file.

docs/setup-run-on-rpi.md

@@ -20,10 +20,20 @@
 #### Install
 - Install studio by executing following script
 
+##### Linux
 ```bash
 curl -fsSL https://raw.githubusercontent.com/jr-k/obscreen/master/system/install-studio.sh -o /tmp/install-studio.sh && chmod +x /tmp/install-studio.sh && sudo /bin/bash /tmp/install-studio.sh $USER $HOME
 sudo reboot
 ```
+##### Windows & MacOS
+```bash
+git clone https://github.com/jr-k/obscreen.git
+cd obscreen
+python3 -m venv venv
+source ./venv/bin/activate
+pip install .
+cp .env.dist .env
+```
 
 #### Configure
 - Server configuration is editable in `.env` file.

requirements.txt

@@ -6,3 +6,4 @@ waitress
 flask-login
 pysqlite3
 psutil
+pymediainfo

setup.py

@@ -0,0 +1,56 @@
+#  obscreen
+#  ---------------
+#  A fancy self-hosted digital signage tool. Free, simple and working.
+#
+#  Author:  jr-k (c) 2024
+#  Website: https://github.com/jr-k/obscreen
+#  License: GPLv2 (see LICENSE file)
+
+import os
+import sys
+import logging
+
+from setuptools import setup, find_packages
+
+common_dependencies = [
+    'flask==2.3.3',
+    'flask-restx==1.3.0',
+    'python-dotenv',
+    'cron-descriptor',
+    'waitress',
+    'flask-login',
+    'psutil',
+    'pymediainfo',
+    'pysqlite3',
+]
+
+if sys.platform == "win32":
+    common_dependencies.remove('pysqlite3')
+
+if sys.platform == "darwin":
+    common_dependencies.remove('pysqlite3')
+
+os.environ['PYTHONUTF8'] = '1'
+os.environ['PYTHONIOENCODING'] = 'utf-8'
+
+setup(
+    name='obscreen',
+    version=open('version.txt').read(),
+    description='A fancy self-hosted digital signage tool. Free, simple and working.',
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+    author='JRK',
+    author_email='jrk@jierka.com',
+    url='https://github.com/jr-k/obscreen',
+    packages=find_packages(),
+    platforms='any',
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
+        'Operating System :: OS Independent',
+        'Topic :: Desktop Environment :: Screen Savers',
+        'Topic :: Multimedia :: Graphics'
+    ],
+    python_requires='>=3.6',
+    install_requires=common_dependencies,
+)