don't run command, just print it

Author: scivision

File-Streaming.md

@@ -1,75 +1,7 @@
 # File Livestream
 
-Captions: if you have installed the optional `tinytag` Python module,
-the Title - Artist will be added automatically onto the video from the
-audio/video files.
-
-## Loop single video endlessly
+Stream single video file:
 
 ```sh
 python -m pylivestream.loopfile videofile site
 ```
-
-## several video files
-
-Glob list of video files to stream:
-
-```sh
-python -m pylivestream.fglob path site -glob glob_pattern
-```
-
-* `-glob` glob pattern of files to stream e.g. `*.avi`.  For [recursive globbing](https://docs.python.org/3/library/pathlib.html#pathlib.Path.glob), do like `**/*.avi`.
-* `-loop` optionally loop endlessly the globbed file list
-* `-shuffle` optionally shuffle the globbed file list
-* `-image` if you have AUDIO files, you should normally set an image to display, as most/all streaming sites REQUIRE a video feed--even a static image.
-* `-nometa` disable Title - Artist text overlay
-
-## stream all videos in directory
-
-Example: all AVI videos in directory `~/Videos`:
-
-```sh
-python -m pylivestream.fglob ~/Videos youtube -glob "*.avi"
-```
-
-## stream endlessly looping videos
-
-Example: all AVI videos in `~/Videos` are endlessly looped:
-
-```sh
-python -m pylivestream.fglob ~/Videos youtube -glob "*.avi" -loop
-```
-
-## stream m3u8 playlist
-
-m3u8 playlist [example](./Examples/playlist_m3u8.py)
-
-## stream all audio files in directory
-
-Glob list of video files to stream. Suggest including a static -image (could be your logo):
-
-```sh
-python -m pylivestream.fglob path site -glob glob_pattern -image image
-```
-
-* `path` path to where video files are
-* `glob_pattern` e.g. `*.avi` pattern matching video files
-* `-image` filename of image to use as stream background (REQUIRED for most websites)
-
-Example: stream all .mp3 audio under `~/music` directory:
-
-```sh
-python -m pylivestream.fglob ~/music youtube -glob "*.mp3" -image mylogo.jpg
-```
-
-Example: stream all .mp3 audio in `~/music` with an animated GIF or video clip repeating:
-
-```sh
-python -m pylivestream.fglob ~/music youtube -glob "*.mp3" -image myclip.avi
-```
-
-or
-
-```sh
-python -m pylivestream.fglob ~/music youtube -glob "*.mp3" -image animated.gif
-```

README.md

@@ -2,10 +2,12 @@
 
 [![DOI](https://zenodo.org/badge/91214767.svg)](https://zenodo.org/badge/latestdoi/91214767)
 ![Actions Status](https://github.com/scivision/pylivestream/workflows/ci/badge.svg)
-[![pypi versions](https://img.shields.io/pypi/pyversions/PyLivestream.svg)](https://pypi.python.org/pypi/PyLivestream)
-[![PyPi Download stats](https://static.pepy.tech/badge/pylivestream)](https://pepy.tech/project/pylivestream)
+[![PyPI versions](https://img.shields.io/pypi/pyversions/PyLivestream.svg)](https://pypi.python.org/pypi/PyLivestream)
+[![PyPI Download stats](https://static.pepy.tech/badge/pylivestream)](https://pepy.tech/project/pylivestream)
 
-Streams to a livestreaming video service, using pure object-oriented Python (no extra packages) to call FFmpeg.
+NOTE: This project is archived effectively. Use OBS Studio etc. for livestreaming.
+
+Emits command to run FFmpeg for livestreaming video services, using pure object-oriented Python.
 Tested with `flake8`, `mypy` type checking and `pytest`.
 `visual_tests.py` is a quick check of several command line scripting scenarios on your laptop.
 FFmpeg is used from Python `subprocess` to stream to sites including:
@@ -48,8 +50,6 @@ Other projects using FFmpeg from Python include:
 
 ## Install
 
-Requires FFmpeg ≥ 4.2 for RTMPS as required or recommended by Facebook Live, YouTube Live, etc.
-
 Latest release:
 
 ```sh
@@ -128,9 +128,6 @@ v4l2-ctl --list-devices
 
 ## API
 
-There are two ways to start a stream (assuming you've configured as per following sections).
-Both do the same thing.
-
 * command line
   * python -m pylivestream.fglob
   * python -m pylivestream.screen
@@ -152,7 +149,7 @@ The user must specify this JSON file location.
 
 1. [configure](https://www.youtube.com/live_dashboard) YouTube Live.
 2. Edit "pylivestream.json" to have the YouTube streamid
-3. Run Python script and chosen input will stream on YouTube Live.
+3. Run Python script for YouTube with chosen input
 
 ```sh
 python -m pylivestream.screen youtube ./pylivestream.json
@@ -183,14 +180,16 @@ python -m pylivestream.screen twitch ./pylivestream.json
 
 ## Usage
 
-Due to the complexity of streaming and the non-specific error codes FFmpeg emits, the default behavior is that if FFmpeg detects one stream has failed, ALL streams will stop streaming and the program ends.
-
 Setup a pylivestream.json for computer and desired parameters.
 Copy the provided
 [pylivestream.json](./src/pylivestream/data/pylivestream.json)
 and edit with values you determine.
 
-[File-Streaming](./File-Streaming.md)
+Single video file:
+
+```sh
+python -m pylivestream.loopfile videofile youtube
+```
 
 ### Camera
 
@@ -201,43 +200,32 @@ JSON:
 * `camera_size`: camera resolution -- find from `v4l2-ctl --list-formats-ext` or camera spec sheet.
 * `camera_fps`: camera fps -- found from command above or camera spec sheet
 
-Stream to livestreaming service using FFmpeg.
 ```sh
 python -m pylivestream.camera youtube ./pylivestream.json
 ```
 
-### Screen Share Livestream
-
-Stream to livestreaming service, in this example Facebook Live:
+Screenshare Livestream:
 
 ```sh
 python -m pylivestream.screen facebook ./pylivestream.json
 ```
 
-### Image + Audio Livestream
-
-Microphone audio + static image is accomplished by
+Microphone audio + static image is accomplished by:
 
 ```sh
 python -m pylivestream.microphone youtube ./pylivestream.json -image doc/logo.jpg
 ```
 
-or wherever your image file is.
-
 ### Audio-only Livestream
 
 Audio-only streaming is not typically allowed by the Video streaming sites.
 It may fail to work altogether, or may fail when one file is done and another starts.
-That's not something we can fix within the scope of this project.
-You can test it to your own computer by:
 
 ```sh
 python -m pylivestream.microphone localhost ./pylivestream.json
 ```
 
-### Screen capture to disk
-
-This script saves your screen capture to a file on your disk:
+Saves screen capture to a file on your disk:
 
 ```sh
 python -m pylivestream.screen2disk myvid.avi ./pylivestream.json

pyproject.toml

@@ -27,7 +27,6 @@ version = {attr = "pylivestream.__version__"}
 [project.optional-dependencies]
 tests = ["pytest", "pytest-timeout"]
 lint = ["flake8", "flake8-bugbear", "flake8-builtins", "flake8-blind-except", "mypy"]
-captions = ["tinytag"]
 
 [tool.black]
 line-length = 100

src/pylivestream/api.py

@@ -12,12 +12,10 @@
 from pathlib import Path
 
 from .base import FileIn, Microphone, SaveDisk, Camera
-from .fglob import stream_files
 from .screen import stream_screen
 
 __all__ = [
     "stream_file",
-    "stream_files",
     "stream_microphone",
     "stream_camera",
     "stream_screen",
@@ -35,14 +33,7 @@ def stream_file(
 ):
     S = FileIn(ini_file, websites, infn=video_file, loop=loop, yes=assume_yes, timeout=timeout)
 
-    # %% Go live
-    if assume_yes:
-        print(f"going live on {websites} with file {video_file}")
-    else:
-        input(f"Press Enter to go live on {websites} with file {video_file}")
-        print("Or Ctrl C to abort.")
-
-    S.stream.startlive()
+    print(" ".join(S.stream.cmd))
 
 
 def stream_microphone(
@@ -57,15 +48,9 @@ def stream_microphone(
     livestream audio, with still image background
     """
 
-    s = Microphone(ini_file, websites, image=still_image, yes=assume_yes, timeout=timeout)
-
-    # %% Go live
-    if assume_yes:
-        print("going live on", websites)
-    else:
-        input(f"Press Enter to go live on {websites}.    Or Ctrl C to abort.")
+    S = Microphone(ini_file, websites, image=still_image, yes=assume_yes, timeout=timeout)
 
-    s.stream.startlive()
+    print(" ".join(S.stream.cmd))
 
 
 def capture_screen(
@@ -85,10 +70,5 @@ def capture_screen(
 def stream_camera(ini_file: Path, websites: str, *, assume_yes: bool, timeout: float):
 
     S = Camera(ini_file, websites, yes=assume_yes, timeout=timeout)
-    # %% Go live
-    if assume_yes:
-        print("going live on", websites)
-    else:
-        input(f"Press Enter to go live on {websites}.    Or Ctrl C to abort.")
 
-    S.stream.startlive()
+    print(" ".join(S.stream.cmd))