TonieToolbox 0.4.0__tar.gz → 0.4.2__tar.gz

{tonietoolbox-0.4.0/TonieToolbox.egg-info → tonietoolbox-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TonieToolbox
-Version: 0.4.0
+Version: 0.4.2
 Summary: Convert audio files to Tonie box compatible format
 Home-page: https://github.com/Quentendo64/TonieToolbox
 Author: Quentendo64
@@ -20,6 +20,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: protobuf<=3.19.0
+Requires-Dist: mutagen>=1.47.0
 Dynamic: author
 Dynamic: home-page
 Dynamic: license-file
@@ -42,8 +43,10 @@ A Python tool for converting audio files to Tonie box compatible format (TAF - T
 - [Installation](#installation)
   - [Install from PyPI (Recommended)](#install-from-pypi-recommended)
   - [Install from Source](#install-from-source)
+  - [Using Docker](#using-docker)
 - [Usage](#usage)
   - [Basic Usage](#basic-usage)
+  - [Docker Usage](#docker-usage)
   - [Advanced Options](#advanced-options)
   - [Common Usage Examples](#common-usage-examples)
   - [Media Tags](#media-tags)
@@ -106,6 +109,32 @@ cd TonieToolbox
 pip install protobuf
 ```
 
+### Using Docker
+
+TonieToolbox is available as a Docker image, which comes with all dependencies pre-installed.
+
+#### Pull the Docker Image
+
+```
+# From Docker Hub
+docker pull quentendo64/tonietoolbox:latest
+
+# From GitHub Packages
+docker pull ghcr.io/quentendo64/tonietoolbox:latest
+```
+
+#### Build the Docker Image Locally
+
+```
+docker build -t tonietoolbox .
+```
+
+Or using docker-compose:
+
+```
+docker-compose build
+```
+
 ## Usage
 
 ### Basic Usage
@@ -162,6 +191,41 @@ By default, all generated TAF files are saved in the `.\output` directory. If yo
 tonietoolbox --recursive --output-to-source "Music/Albums"
 ```
 
+### Docker Usage
+
+Using TonieToolbox with Docker simplifies the setup process as all dependencies (FFmpeg and opus-tools) are pre-installed.
+
+**Convert a single audio file to Tonie format:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3
+
+# Or using docker-compose
+docker-compose run --rm tonietoolbox input/my-audio-file.mp3
+```
+
+**Process folders recursively:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive input/folder
+
+```
+
+**Advanced options with Docker:**
+
+```bash
+# Convert with custom settings
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive --use-media-tags --name-template "{album} - {artist}" --bitrate 128 input/folder
+```
+
+**Upload to TeddyCloud with Docker:**
+
+```bash
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3 --upload https://teddycloud.example.com --include-artwork
+```
+
 ### Advanced Options
 
 Run the following command to see all available options:
@@ -328,7 +392,7 @@ tonietoolbox --recursive "\Hörspiele\Die drei Fragezeichen\Folgen"
 Process a music collection with nested album folders and save TAF files alongside the source directories:
 
 ```
-tonietoolbox --recursive --output-to-source "\Hörspiele\"
+tonietoolbox --recursive --output-to-source "\Hörspiele\" 
 ```
 
 #### Automatic dependency download:

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2}/README.md

@@ -15,8 +15,10 @@ A Python tool for converting audio files to Tonie box compatible format (TAF - T
 - [Installation](#installation)
   - [Install from PyPI (Recommended)](#install-from-pypi-recommended)
   - [Install from Source](#install-from-source)
+  - [Using Docker](#using-docker)
 - [Usage](#usage)
   - [Basic Usage](#basic-usage)
+  - [Docker Usage](#docker-usage)
   - [Advanced Options](#advanced-options)
   - [Common Usage Examples](#common-usage-examples)
   - [Media Tags](#media-tags)
@@ -79,6 +81,32 @@ cd TonieToolbox
 pip install protobuf
 ```
 
+### Using Docker
+
+TonieToolbox is available as a Docker image, which comes with all dependencies pre-installed.
+
+#### Pull the Docker Image
+
+```
+# From Docker Hub
+docker pull quentendo64/tonietoolbox:latest
+
+# From GitHub Packages
+docker pull ghcr.io/quentendo64/tonietoolbox:latest
+```
+
+#### Build the Docker Image Locally
+
+```
+docker build -t tonietoolbox .
+```
+
+Or using docker-compose:
+
+```
+docker-compose build
+```
+
 ## Usage
 
 ### Basic Usage
@@ -135,6 +163,41 @@ By default, all generated TAF files are saved in the `.\output` directory. If yo
 tonietoolbox --recursive --output-to-source "Music/Albums"
 ```
 
+### Docker Usage
+
+Using TonieToolbox with Docker simplifies the setup process as all dependencies (FFmpeg and opus-tools) are pre-installed.
+
+**Convert a single audio file to Tonie format:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3
+
+# Or using docker-compose
+docker-compose run --rm tonietoolbox input/my-audio-file.mp3
+```
+
+**Process folders recursively:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive input/folder
+
+```
+
+**Advanced options with Docker:**
+
+```bash
+# Convert with custom settings
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive --use-media-tags --name-template "{album} - {artist}" --bitrate 128 input/folder
+```
+
+**Upload to TeddyCloud with Docker:**
+
+```bash
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3 --upload https://teddycloud.example.com --include-artwork
+```
+
 ### Advanced Options
 
 Run the following command to see all available options:
@@ -301,7 +364,7 @@ tonietoolbox --recursive "\Hörspiele\Die drei Fragezeichen\Folgen"
 Process a music collection with nested album folders and save TAF files alongside the source directories:
 
 ```
-tonietoolbox --recursive --output-to-source "\Hörspiele\"
+tonietoolbox --recursive --output-to-source "\Hörspiele\" 
 ```
 
 #### Automatic dependency download:

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2}/TonieToolbox/__init__.py

@@ -2,4 +2,4 @@
 TonieToolbox - Convert audio files to Tonie box compatible format
 """
 
-__version__ = '0.4.0'
+__version__ = '0.4.2'

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2/TonieToolbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TonieToolbox
-Version: 0.4.0
+Version: 0.4.2
 Summary: Convert audio files to Tonie box compatible format
 Home-page: https://github.com/Quentendo64/TonieToolbox
 Author: Quentendo64
@@ -20,6 +20,7 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: protobuf<=3.19.0
+Requires-Dist: mutagen>=1.47.0
 Dynamic: author
 Dynamic: home-page
 Dynamic: license-file
@@ -42,8 +43,10 @@ A Python tool for converting audio files to Tonie box compatible format (TAF - T
 - [Installation](#installation)
   - [Install from PyPI (Recommended)](#install-from-pypi-recommended)
   - [Install from Source](#install-from-source)
+  - [Using Docker](#using-docker)
 - [Usage](#usage)
   - [Basic Usage](#basic-usage)
+  - [Docker Usage](#docker-usage)
   - [Advanced Options](#advanced-options)
   - [Common Usage Examples](#common-usage-examples)
   - [Media Tags](#media-tags)
@@ -106,6 +109,32 @@ cd TonieToolbox
 pip install protobuf
 ```
 
+### Using Docker
+
+TonieToolbox is available as a Docker image, which comes with all dependencies pre-installed.
+
+#### Pull the Docker Image
+
+```
+# From Docker Hub
+docker pull quentendo64/tonietoolbox:latest
+
+# From GitHub Packages
+docker pull ghcr.io/quentendo64/tonietoolbox:latest
+```
+
+#### Build the Docker Image Locally
+
+```
+docker build -t tonietoolbox .
+```
+
+Or using docker-compose:
+
+```
+docker-compose build
+```
+
 ## Usage
 
 ### Basic Usage
@@ -162,6 +191,41 @@ By default, all generated TAF files are saved in the `.\output` directory. If yo
 tonietoolbox --recursive --output-to-source "Music/Albums"
 ```
 
+### Docker Usage
+
+Using TonieToolbox with Docker simplifies the setup process as all dependencies (FFmpeg and opus-tools) are pre-installed.
+
+**Convert a single audio file to Tonie format:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3
+
+# Or using docker-compose
+docker-compose run --rm tonietoolbox input/my-audio-file.mp3
+```
+
+**Process folders recursively:**
+
+```bash
+# Use docker run
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive input/folder
+
+```
+
+**Advanced options with Docker:**
+
+```bash
+# Convert with custom settings
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox --recursive --use-media-tags --name-template "{album} - {artist}" --bitrate 128 input/folder
+```
+
+**Upload to TeddyCloud with Docker:**
+
+```bash
+docker run --rm -v "$(pwd)/input:/tonietoolbox/input" -v "$(pwd)/output:/tonietoolbox/output" quentendo64/tonietoolbox input/my-audio-file.mp3 --upload https://teddycloud.example.com --include-artwork
+```
+
 ### Advanced Options
 
 Run the following command to see all available options:
@@ -328,7 +392,7 @@ tonietoolbox --recursive "\Hörspiele\Die drei Fragezeichen\Folgen"
 Process a music collection with nested album folders and save TAF files alongside the source directories:
 
 ```
-tonietoolbox --recursive --output-to-source "\Hörspiele\"
+tonietoolbox --recursive --output-to-source "\Hörspiele\" 
 ```
 
 #### Automatic dependency download:

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2}/TonieToolbox.egg-info/requires.txt

@@ -1 +1,2 @@
 protobuf<=3.19.0
+mutagen>=1.47.0

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2}/pyproject.toml

@@ -23,6 +23,7 @@ classifiers = [
 ]
 dependencies = [
     "protobuf<=3.19.0",
+    "mutagen>=1.47.0"
 ]
 requires-python = ">=3.6"
 

{tonietoolbox-0.4.0 → tonietoolbox-0.4.2}/setup.py

@@ -22,7 +22,7 @@ setup(
     version=version,
     author="Quentendo64",
     author_email="quentin@wohlfeil.at",
-    description="Convert audio files to Tonie box compatible format",
+    description="Convert audio files to Toniebox compatible format (.TAF)",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/Quentendo64/TonieToolbox",
@@ -41,6 +41,7 @@ setup(
     python_requires=">=3.6",
     install_requires=[
         "protobuf<=3.19.0",
+        "mutagen>=1.47.0"
     ],
     entry_points={
         'console_scripts': [