|
1 | 1 | # shipper |
2 | 2 | **shipper** is a utility with the purpose of making re-encoding and compressing of movies and TV shows easier. While it is built with Plex in mind, it can be used for anything. It is comprised of a daemon which can be run in the background and also acts as a dashboard for current jobs as well as a input script to safely add new jobs to the queue. |
3 | 3 |
|
| 4 | +If you try to use it and have any problems or questions feel free to make a issue and I'll get back to you asap. |
4 | 5 |
|
5 | 6 | > [!WARNING] |
6 | 7 | > This repository is very much **work in progress**. Most commits will break previous versions. It is likely that many features will only partly work or not work at all. |
@@ -61,44 +62,6 @@ Features |
61 | 62 | - Safe stopping of program with a `stop` file. |
62 | 63 | - Show progress of current jobs. |
63 | 64 |
|
64 | | -Todo |
65 | | ---- |
66 | | -<details> |
67 | | -<summary>9/29 Complete</summary> |
68 | | - |
69 | | -- [x] Change flags (stop, unstop) to use .flag suffix to avoid committing. |
70 | | -- [ ] Reorganise file structure to move functions to their own files. |
71 | | - - [ ] daemon |
72 | | - - [ ] input |
73 | | - - [ ] status |
74 | | - |
75 | | -- [ ] input.py |
76 | | - - [ ] Allow custom output file name formats |
77 | | - - [ ] Fix ctrl+c throwing 20 lines of error |
78 | | - - [ ] Potentially make part of status.py TUI |
79 | | -- [ ] status.py |
80 | | - - [ ] Consider moving to TUI frontend such as textualize which would allow it to run as webpage. |
81 | | - - [ ] Running status or input should trigger daemon to start. |
82 | | -- [ ] compress_file.sh |
83 | | - - [x] Turn into python script. |
84 | | - - [x] Checks if file exists |
85 | | - - [x] Checks valid preset & gets preset values |
86 | | - - [x] Check enough disk space |
87 | | - - [x] Fail job if output already exists |
88 | | - - [x] If english audio exists, use it |
89 | | - - [x] If english subs exist, use them |
90 | | - - [x] Run ffmpeg |
91 | | - - [ ] Warn if output > input |
92 | | -- [ ] daemon.py |
93 | | - - [ ] Integrate new compression integration |
94 | | - - [ ] Move all ffmpeg to using external functions |
95 | | - |
96 | | -- [ ] Prompt user for missing config.json & .env values when initially running input.py. |
97 | | -- [ ] Allow editing of current jobs. |
98 | | -- [ ] Add help/info command |
99 | | -- [ ] `scp` jobs for automatically moving files to a different device. |
100 | | -</details> |
101 | | - |
102 | 65 | # config.json Parameters |
103 | 66 |
|
104 | 67 | `input_dir`: Full path to the directory where the input script will show files from. |
|
0 commit comments