From 72dd9d4e0e4ddce8046eea90ab7b702e2689641f Mon Sep 17 00:00:00 2001 From: sharky555 Date: Tue, 21 Jun 2022 18:48:38 -0600 Subject: [PATCH] readme updated --- README.md | 27 +++++++++++++-------------- json_data/config.json.example | 1 - 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d3e288f..d5e9955 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ -This project is **NOT** being maintained as i'd rather rewrite it from scratch. - ## Overview **JPS-AU** is a tool for automating the uploading process on jpopsuki.eu. -This is intended to be used alongside BugsPy. **Features:** - JPS Client. - FTP Support -- FLAC/MP3 Support. -- BugsPy .log Support. +- FLAC Support. **Installation:** - Install requirements @@ -22,33 +18,36 @@ python autoupload.py {command_name} {ID/URL} ``` Command | Description | Example ------------- | ------------- | ------------- --d, --debug | Provides additional information on upload for debugging purposes | `python autoupload.py -d` --f, --freeleech | Enables freeleech (VIP+ Userclass Requirement) | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"` +-dir, --directory | Appoint directory used for torrent creation | `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]"` +-a, --artist | Set the artists. (Romaji\English) | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]" -a "Ego"` +-ti, --title | Set the title. (Romaji\English) | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]"` +-rt, --releasetype | Set the release type. (Album, Single, EP) | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]" -rt "Album"` -t, --tags | Add additional tags to upload, separated with comma | `python autoupload.py -t "korean, female.vocalist" -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"` --dir, --directory | Appoint directory used for torrent creation | `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]"` --dry, --dryrun | Carries out all actions other than the upload itself.| `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-MP3]" -dry` +-eti, --editiontitle | Set the edition title | +-ey, --editionyear | Set the torrent edition year (YYYY). | +-tdes, --torrentdescription | Add a torrent description. NOT the tracklist description. +-im, --imageURL|Set the torrent cover URL. This is optional as this script can read a cover file from the directory you chose. +-d, --debug | Provides additional information on upload for debugging purposes | `python autoupload.py -d` +-f, --freeleech | Enables freeleech (VIP+ Userclass Requirement) | `python autoupload.py -f -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]"` +-dry, --dryrun | Carries out all actions other than the upload itself.| `python autoupload.py -dir "Z:\Music\Korean\Ego\Ego - E [2020.01.02] [EP] [WEB-FLAC]" -dry` ## Config.json - 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. -- 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. -- Similarly to generate_tracklist, if enable_release_description is 'true' the script will create a url to the Bugs.co.kr album webpage to display the source, this can easily be edited to suit your needs within the gatherdata() function **credentials:** Config | Description | Example ------------- | ------------- | ------------- -Username | JPopSuki Username | Slyy +Username | JPopSuki Username | Username Password | JPopSuki Password | Password **local_prefs** Config | Description | Example ------------- | ------------- | ------------- -log_directory | directory containing BugsPy log files | `Z:/Bugs/Logs` generate_tracklist | enable tracklist generation | `true/false` save_tracklist | write tracklist to .log and save in log folder | `true/false` -enable_release_description | post comments tag to release description | `true/false` cover_name | name of cover with extension | `cover.jpg` add_to_watch_folder | moves .torrent file to local watch folder | `true/false` add_to_downloads_folder | moves torrent data to local downloads folder | `true/false` diff --git a/json_data/config.json.example b/json_data/config.json.example index 0783441..8fb36c6 100644 --- a/json_data/config.json.example +++ b/json_data/config.json.example @@ -4,7 +4,6 @@ "password": "password" }, "local_prefs": { - "log_directory": "D:/Bugs/BugsPy-master/logs", "generate_tracklist": true, "save_tracklist": false, "enable_release_description": false,