up2fireshare 1.0.0__tar.gz

up2fireshare-1.0.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: up2fireshare
+Version: 1.0.0
+Summary: Add your description here
+Author: LittleBit
+Author-email: LittleBit <littlebit@littlebitstudios.com>
+License-Expression: MIT
+Requires-Dist: argparse>=1.4.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.34.2
+Requires-Dist: xxhash>=4.0.1
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# up2fireshare
+
+A CLI for uploading game clips to the Fireshare self-hosted gaming media collection system.
+
+## Installation
+
+up2fireshare is a Python package uploaded to PyPI so it can be installed with pip or pipx (preferably pipx).
+
+```sh
+pipx install up2fireshare
+```
+
+Most Linux distros provide pipx for running Python-based CLI tools, it can also be installed as `pip install pipx` on Windows or in cases where there is no distro package for pipx (for MacOS with `brew` (https://brew.sh), install with `brew install pipx`).
+
+## Usage
+
+On first use you'll need to copy the `example-config.yaml` file to your PC as `[HOME FOLDER]/.littlebitstudios/up2fireshare/config.yaml`.
+
+Your home folder should be `/home/username` on Linux, `/Users/username` on MacOS, or `C:/Users/Your Name` on Windows. If Windows was set up with a Microsoft Account, the home folder will be `C:/Users/[first 5 letters of email]`.
+
+The most basic way to run the program is
+```sh
+up2fireshare /path/to/media/file
+```
+You can also use `-g` to specify a game name (this game must be one you've added already from Fireshare's interface), the name is case-insensitive. You can also use `-f` to specify the folder name within Fireshare to upload to.
+
+If you want to use Fireshare's tags, you can use `-t "tag1, tag2, ..."` to upload with tags.
+
+To upload multiple files at once, just add more than one file. For an entire folder, use `/path/to/media/folder/*`. Do note that when uploading multiple files, you can't use a title (`-n`) and all other options are copied across the files. Useful if you're uploading an entire folder that's categorized by game.
+
+The program's full helptext can be seen with `up2fireshare -h`.
+
+## Licensing/Credits
+
+This tool is open-source under the MIT license. See the LICENSE file.
+
+This tool interacts with Fireshare (https://github.com/shaneisrael/fireshare), open-source software under the GPL-3.0 license.

up2fireshare-1.0.0/README.md

@@ -0,0 +1,37 @@
+# up2fireshare
+
+A CLI for uploading game clips to the Fireshare self-hosted gaming media collection system.
+
+## Installation
+
+up2fireshare is a Python package uploaded to PyPI so it can be installed with pip or pipx (preferably pipx).
+
+```sh
+pipx install up2fireshare
+```
+
+Most Linux distros provide pipx for running Python-based CLI tools, it can also be installed as `pip install pipx` on Windows or in cases where there is no distro package for pipx (for MacOS with `brew` (https://brew.sh), install with `brew install pipx`).
+
+## Usage
+
+On first use you'll need to copy the `example-config.yaml` file to your PC as `[HOME FOLDER]/.littlebitstudios/up2fireshare/config.yaml`.
+
+Your home folder should be `/home/username` on Linux, `/Users/username` on MacOS, or `C:/Users/Your Name` on Windows. If Windows was set up with a Microsoft Account, the home folder will be `C:/Users/[first 5 letters of email]`.
+
+The most basic way to run the program is
+```sh
+up2fireshare /path/to/media/file
+```
+You can also use `-g` to specify a game name (this game must be one you've added already from Fireshare's interface), the name is case-insensitive. You can also use `-f` to specify the folder name within Fireshare to upload to.
+
+If you want to use Fireshare's tags, you can use `-t "tag1, tag2, ..."` to upload with tags.
+
+To upload multiple files at once, just add more than one file. For an entire folder, use `/path/to/media/folder/*`. Do note that when uploading multiple files, you can't use a title (`-n`) and all other options are copied across the files. Useful if you're uploading an entire folder that's categorized by game.
+
+The program's full helptext can be seen with `up2fireshare -h`.
+
+## Licensing/Credits
+
+This tool is open-source under the MIT license. See the LICENSE file.
+
+This tool interacts with Fireshare (https://github.com/shaneisrael/fireshare), open-source software under the GPL-3.0 license.

up2fireshare-1.0.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "up2fireshare"
+license = "MIT"
+version = "1.0.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "argparse>=1.4.0",
+    "pyyaml>=6.0.3",
+    "requests>=2.34.2",
+    "xxhash>=4.0.1",
+]
+
+[[project.authors]]
+name = "LittleBit"
+email = "littlebit@littlebitstudios.com"
+
+[project.scripts]
+up2fireshare = "up2fireshare:main"
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14.0"]
+build-backend = "uv_build"

up2fireshare-1.0.0/pyproject.toml.orig

@@ -0,0 +1,23 @@
+[project]
+name = "up2fireshare"
+license = "MIT"
+version = "1.0.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "LittleBit", email = "littlebit@littlebitstudios.com" }
+]
+requires-python = ">=3.13"
+dependencies = [
+    "argparse>=1.4.0",
+    "pyyaml>=6.0.3",
+    "requests>=2.34.2",
+    "xxhash>=4.0.1",
+]
+
+[project.scripts]
+up2fireshare = "up2fireshare:main"
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14.0"]
+build-backend = "uv_build"

up2fireshare-1.0.0/src/up2fireshare/__init__.py

@@ -0,0 +1,196 @@
+import argparse
+import os
+from pathlib import Path
+import requests
+import xxhash
+import yaml
+
+
+_VIDEO_EXTENSIONS = {".mp4", ".m4v", ".mov", ".webm"}
+_IMAGE_EXTENSIONS = {".jpg", ".jpeg", ".png", ".webp", ".gif"}
+_HASH_BYTES = 16 * 1024 * 1024
+
+
+def _default_config_path():
+    return Path.home() / ".littlebitstudios" / "up2fireshare" / "config.yaml"
+
+
+def load_config(config_path=None):
+    config_file = Path(config_path).expanduser() if config_path else _default_config_path()
+
+    if not config_file.exists():
+        raise FileNotFoundError(f"Copy the example-config.yaml file from the repository to {config_file.parent}.\nRename the file to config.yaml and fill in the values for your Fireshare server.\nMake sure you specified --config if not using a config file in the default location.")
+
+    with config_file.open("r", encoding="utf-8") as handle:
+        config = yaml.safe_load(handle) or {}
+
+    if not isinstance(config, dict):
+        raise ValueError("The config file must contain a YAML mapping.")
+
+    server = config.get("server")
+    token = config.get("token")
+    if not server or not token:
+        raise KeyError("The config file must contain both 'server' and 'token'.")
+
+    return {"server": str(server).rstrip("/"), "token": str(token)}
+
+
+def _media_id(file_path):
+    extension = Path(file_path).suffix.lower()
+    if extension in _VIDEO_EXTENSIONS:
+        field = "video_id"
+    elif extension in _IMAGE_EXTENSIONS:
+        field = "image_id"
+    else:
+        return None
+
+    hasher = xxhash.xxh3_128()
+    with open(file_path, "rb") as handle:
+        hasher.update(handle.read(_HASH_BYTES))
+    return field, hasher.hexdigest()
+
+
+def upload_file(file_path, server, token, *, title=None, folder=None, game=None, tags=None):
+    file_name = Path(file_path).name
+    server_url = str(server).rstrip("/")
+    upload_url = f"{server_url}/api/upload/token"
+    payload = {}
+
+    if title is not None:
+        payload["title"] = str(title)
+    if folder is not None:
+        payload["folder"] = str(folder)
+    if game is not None:
+        payload["game"] = str(game)
+    if tags is not None:
+        payload["tag_ids"] = str(tags).strip()
+
+    media_id = _media_id(file_path)
+    if media_id is not None:
+        id_field, file_id = media_id
+        exists_response = requests.get(
+            f"{server_url}/api/upload/token/exists",
+            params={id_field: file_id},
+            headers={"Authorization": f"Bearer {token}"},
+            timeout=60,
+        )
+        exists_response.raise_for_status()
+        exists_result = exists_response.json()
+        if exists_result.get("exists") is True:
+            return exists_result
+
+    with open(file_path, "rb") as handle:
+        response = requests.post(
+            upload_url,
+            files={"file": (file_name, handle, "application/octet-stream")},
+            data=payload,
+            headers={"Authorization": f"Bearer {token}"},
+            timeout=60,
+        )
+
+    try:
+        return response.json()
+    except ValueError:
+        return {"status_code": response.status_code, "text": response.text}
+    
+def get_user_data(server, token):
+    response = requests.get(f"{server}/api/upload/token", headers={"Authorization": f"Bearer {token}"})
+    
+    try:
+        return response.json()
+    except ValueError:
+        return {"status_code": response.status_code, "text": response.text}
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Upload one or more files to a Fireshare instance."
+    )
+    parser.add_argument(
+        "files",
+        nargs="+",
+        help="File(s) to upload. Whether Fireshare treats them as video or photo depends on extension.",
+    )
+    parser.add_argument(
+        "--name",
+        "-n",
+        help="Title of the upload in Fireshare. Defaults to the filename (without extension).",
+    )
+    parser.add_argument(
+        "--tags",
+        "-t",
+        help="Tags to apply to uploaded clip(s), comma-separated.",
+    )
+    parser.add_argument(
+        "--folder",
+        "-f",
+        help="Folder on your Fireshare server to assign the clip to. Default: your server's upload folder.",
+    )
+    parser.add_argument(
+        "--game",
+        "-g",
+        help="Game name to assign to uploaded clip(s), case insensitive. Game must exist on your server already.",
+    )
+    parser.add_argument(
+        "--config",
+        help="Path to the YAML config file. Defaults to ~/.littlebitstudios/up2fireshare/config.yaml.",
+    )
+
+    args = parser.parse_args()
+    if args.name is not None and len(args.files) > 1:
+        parser.error("the title option (-n/--name) can only be used with a single file")
+
+    try:
+        config = load_config(args.config)
+    except FileNotFoundError as exc:
+        print(str(exc))
+        return 1
+    except (KeyError, ValueError) as exc:
+        print(f"Invalid config: {exc}")
+        return 1
+    
+    user_data=get_user_data(config.get("server"), config.get("token"))
+    if user_data:
+        print(f"connected to {config.get("server")} as user {user_data.get("username")}\n")
+
+    normalized_tags = None
+    if args.tags:
+        normalized_tags = ",".join(part.strip() for part in args.tags.split(",") if part.strip())
+
+    for file_path in args.files:
+        file_path = os.path.expanduser(file_path)
+        if not os.path.exists(file_path):
+            print(f"File not found: {file_path}")
+            return 1
+
+        result = upload_file(
+            file_path,
+            config["server"],
+            config["token"],
+            title=args.name,
+            folder=args.folder,
+            game=args.game,
+            tags=normalized_tags,
+        )
+
+        if isinstance(result, dict):
+            status = (
+                "already exists"
+                if result.get("exists") is True
+                else result.get("status") or result.get("status_code")
+            )
+            print(f"{os.path.basename(file_path)} -> {status}")
+            if result.get("message"):
+                print(result["message"])
+            if result.get("error"):
+                print(result["error"])
+            if result.get("url"):
+                print(f"view item here: {config.get("server")}{result.get("url")}")
+            else:
+                print(result)
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())