1 changed files with 77 additions and 78 deletions
Unified View
Diff Options
-
+77 -78README.md
+ 77
- 78
README.md
View File
| @@ -1,82 +1,77 @@ | |||||
| Rewriting for use for uploading video torrents to sugoimusic | Rewriting for use for uploading video torrents to sugoimusic | ||||
| ## Overview | ## Overview | ||||
| **SM-AU-TV** is a tool for automating the uploading process on sugoimusic.me. | **SM-AU-TV** is a tool for automating the uploading process on sugoimusic.me. | ||||
| **Installation:** | |||||
| **Features:** | - Install requirements | ||||
| - SM Client. | ``` | ||||
| - FTP Support | pip install -r requirements.txt | ||||
| ``` | |||||
| **Installation:** | ## Command Usage | ||||
| - Install requirements | ``` | ||||
| ``` | python upload.py {command_name} | ||||
| pip install -r requirements.txt | ``` | ||||
| ``` | Use the copycommand.txt file to easily copy and paste your command. | ||||
| Command | Description | |||||
| ## Command Usage | ------------- | ------------- | ||||
| ``` | -h, --help | show help message and exit | ||||
| python upload.py {command_name} | -i [INPUT], --input [INPUT] | Initiate upload on input file. This must be added as an argument. | ||||
| ``` | -d, --debug | Enable debug mode. | ||||
| Use the copycommand.txt file to easily copy and paste your command. | -dry, --dryrun | Dryrun will carry out all actions other than the actual upload to SM. | ||||
| -a [ARTISTS], --artists [ARTISTS] | Set the artists. (Romaji\English). Split multiple with "," | |||||
| Command | Description | -oa [ORIGINALARTIST], --originalartist [ORIGINALARTIST] | Set the artist. (Original Language) | ||||
| -h, --help | show help message and exit | -ca [CONTRIBUTINGARTISTS], --contributingartists [CONTRIBUTINGARTISTS] | Set the contributing artists. (Romaji\English). Split multiple with "," | ||||
| -i [INPUT], --input [INPUT] | Initiate upload on input file. This must be added as an argument. | -ti [TITLE], --title [TITLE] | Set the title. (Romaji\English) | ||||
| -d, --debug | Enable debug mode. | -oti [ORIGINALTITLE], --originaltitle [ORIGINALTITLE] | Set the title. (Original Language) | ||||
| -dry, --dryrun | Dryrun will carry out all actions other than the actual upload to SM. | -des [DESCRIPTION], --description [DESCRIPTION] | Add a torrent description. This must be added as an argument. | ||||
| -a [ARTISTS], --artists [ARTISTS] | Set the artists. (Romaji\English). Split multiple with "," | -t [TAGS], --tags [TAGS] | Add additional tags to the upload. At least 2 tags are required | ||||
| -oa [ORIGINALARTIST], --originalartist [ORIGINALARTIST] | Set the artist. (Original Language) | -im [IMAGEURL], --imageURL [IMAGEURL] | Set the torrent cover URL. | ||||
| -ca [CONTRIBUTINGARTISTS], --contributingartists [CONTRIBUTINGARTISTS] | Set the contributing artists. (Romaji\English). Split multiple with "," | -ms [MEDIASOURCE], --mediasource [MEDIASOURCE] | Set the media source. | ||||
| -ti [TITLE], --title [TITLE] | Set the title. (Romaji\English) | -rt [RELEASETYPE], --releasetype [RELEASETYPE] | Set the release type. | ||||
| -oti [ORIGINALTITLE], --originaltitle [ORIGINALTITLE] | Set the title. (Original Language) | -s [SUB], --sub [SUB] | Set the subtitle type. | ||||
| -des [DESCRIPTION], --description [DESCRIPTION] | Add a torrent description. This must be added as an argument. | -l [LANGUAGE], --language [LANGUAGE] | Set the language | ||||
| -t [TAGS], --tags [TAGS] | Add additional tags to the upload. At least 2 tags are required | -y [YEAR], --year [YEAR] | Set the torrent year (YYYYMMDD or YYYY). | ||||
| -im [IMAGEURL], --imageURL [IMAGEURL] | Set the torrent cover URL. | -f, --freeleech | Enables freeleech. | ||||
| -ms [MEDIASOURCE], --mediasource [MEDIASOURCE] | Set the media source. | ## Config.json | ||||
| -rt [RELEASETYPE], --releasetype [RELEASETYPE] | Set the release type. | - It's not recommended to use both local watch/download folders and ftp watch/download folders at the same time as it will result in seeding from 2 locations. | ||||
| -s [SUB], --sub [SUB] | Set the subtitle type. | **credentials:** | ||||
| -l [LANGUAGE], --language [LANGUAGE] | Set the language | Config | Description | Example | ||||
| -y [YEAR], --year [YEAR] | Set the torrent year (YYYYMMDD or YYYY). | ------------- | ------------- | ------------- | ||||
| -f, --freeleech | Enables freeleech. | Username | SugoiMusic Username | Slyy | ||||
| Password | SugoiMusic Password | Password | |||||
| ## Config.json | Passkey | SugoiMusic Passkey | Passkey | ||||
| **local_prefs** | |||||
| - It's not recommended to use both local watch/download folders and ftp watch/download folders at the same time as it will result in seeding from 2 locations. | Config | Description | Example | ||||
| - If generate_tracklist is set to false the script will try and find BugsPy logs within the selected log folder, this will use the comments tag to find the log. For example if 204815 is within your comments tag, it will search your log folder for 204815.log and use the contents of this log for the album description. | ------------- | ------------- | ------------- | ||||
| log_directory | directory containing BugsPy log files | `Z:/Bugs/Logs` | |||||
| **credentials:** | generate_tracklist | enable tracklist generation | `true/false` | ||||
| save_tracklist | write tracklist to .log and save in log folder | `true/false` | |||||
| Config | Description | Example | enable_release_description | post comments tag to release description | `true/false` | ||||
| Username | SugoiMusic Username | Slyy | cover_name | name of cover with extension | `cover.jpg` | ||||
| Password | SugoiMusic Password | Password | add_to_watch_folder | moves .torrent file to local watch folder | `true/false` | ||||
| Passkey | SugoiMusic Passkey | Passkey | add_to_downloads_folder | moves torrent data to local downloads folder | `true/false` | ||||
| local_watch_folder | directory of local watch folder | `Z:/watch/Transmission` | |||||
| **local_prefs** | local_downloads_folder | directory of local downloads folder | `Z:/downloads` | ||||
| **ftp_prefs:** | |||||
| Config | Description | Example | Config | Description | Example | ||||
| log_directory | directory containing BugsPy log files | `Z:/Bugs/Logs` | ------------- | ------------- | ------------- | ||||
| generate_tracklist | enable tracklist generation | `true/false` | enable_ftp | enable ftp mode, if enabled suggested to disable local watch and downloads folders | `true/false` | ||||
| save_tracklist | write tracklist to .log and save in log folder | `true/false` | add_to_watch_folder | transfer .torrent file to watch folder on FTP server | `true/false` | ||||
| enable_release_description | post comments tag to release description | `true/false` | add_to_downloads_folder | transfer torrent data to downloads folder on FTP server | `true/false` | ||||
| cover_name | name of cover with extension | `cover.jpg` | ftp_server | url of ftp server | bestboxever.seedhost.eu | ||||
| add_to_watch_folder | moves .torrent file to local watch folder | `true/false` | ftp_username | username of ftp account | slyy | ||||
| add_to_downloads_folder | moves torrent data to local downloads folder | `true/false` | ftp_password | password of ftp account | password | ||||
| local_watch_folder | directory of local watch folder | `Z:/watch/Transmission` | ftp_watch_folder | directory of ftp watch folder | `/downloads/watch/transmission` | ||||
| local_downloads_folder | directory of local downloads folder | `Z:/downloads` | ftp_downloads_folder | directory of ftp downloads folder | `/downloads` | ||||
| **ftp_prefs:** | |||||
| Config | Description | Example | |||||
| enable_ftp | enable ftp mode, if enabled suggested to disable local watch and downloads folders | `true/false` | |||||
| add_to_watch_folder | transfer .torrent file to watch folder on FTP server | `true/false` | |||||
| add_to_downloads_folder | transfer torrent data to downloads folder on FTP server | `true/false` | |||||
| ftp_server | url of ftp server | bestboxever.seedhost.eu | |||||
| ftp_username | username of ftp account | slyy | |||||
| ftp_password | password of ftp account | password | |||||
| ftp_watch_folder | directory of ftp watch folder | `/downloads/watch/transmission` | |||||
| ftp_downloads_folder | directory of ftp downloads folder | `/downloads` | |||||