mylar

mirror of https://github.com/evilhero/mylar synced 2024-12-23 16:22:45 +00:00

No description

Find a file

DarkSir23 bc8eb58e70 OPDS Comics and Issues		2017-11-01 23:21:20 -04:00
data	OPDS Comics and Issues	2017-11-01 23:21:20 -04:00
init-scripts	FIX/IMP: (#733 ) Redid ubuntu startup scripts, PID will now daemonize and get new PID on restart/shutdown (taken from headphones with love) - put in init-scripts directory.	2014-06-04 16:31:26 -04:00
lib	IMP:New scheduler tab (Manage / Activity) where you can see job current run status', next runtime, and prev runtimes as well as force/pause a job, FIX: Disabling	2017-09-10 11:50:08 -04:00
mylar	OPDS Comics and Issues	2017-11-01 23:21:20 -04:00
post-processing	IMP: Redid configuration completely - added config module and changed structures accordingly. Allow for minimal ini configuration (minimal_ini=True). Updated global/config variables throughout each module as required. Provider order sequence now generated on each save (no longer requires a restart). Bunch of other fixes that were either part of the configuration changeover, or the result of and had to be changed/fixed in order for the this to work	2017-10-25 14:33:56 -04:00
screens	attempted fix for : and & in Comic Titles when adding	2012-09-13 11:27:34 -04:00
.gitignore	FIX: included version of comictagger should now work with both Windows and *nix based OS' again, IMP: Global Copy/Move option available when performing post-processing, IMP: Added a verbose file-checking option (FOLDER_SCAN_LOG_VERBOSE) - when enabled will log as it currently does during manual post-processing/file-checking runs, when disabled it will not spam the log nearly as much resulting in more readable log files, IMP: Added Verbose debug logging both via startup option(-v), as well as toggle button in Log GUI (from headphones), as well as per-page loading of log file(s) in GUI, FIX: When doing manual post-processing on issues that were in story arcs, will now indicate X story-arc issues were post-processed for better visibility, FIX: Fixed an issue with deleting from the nzblog table when story arc issues were post-processed, IMP: Added WEEKFOLDER_LOC to the config.ini to allow for specification of where the weekly download directories will default to (as opposed to off of ComicLocation root), IMP: Better handling of some special character references in series titles when looking for series on the auto-wanted list, IMP: 32P will now auto-disable provider if logon returns invalid credentials, FIX: When using alt_pull on weekly pull list, xA0 unicode character caused error, FIX: If title had invalid character in filename that was replaced with a character that already existed in the title, would not scan in during file-checking, FIX: When searching for a series (weeklypull-list/add a series), if the title contained 'and' or '&' would return really mixed up results, FIX: When Post-Processing, if filename being processed had special characters (ie. comma) and was different than nzbname, in some cases would fail to find/move issues, IMP: Utilize internal comictagger to convert from cbr/cbz, IMP: Added more checks when post-processing to ensure files are handled correctly, IMP: Added meta-tag reading when importing series/issues - if previously tagged with CT, will reverse look-up the provided IssueID to reference the correct ComicID, IMP: If scanned directory during import contins cvinfo file, use that and force the ComicID to entire directory when importing a series, IMP: Manual meta-tagging issues will no longer create temporary directories and/or create files in the Comic Location root causing problems for some users, FIX: Annuals weren't properly sorted upon loading of comic details page for some series, IMP: Added some extra checks when validating/creating directories, FIX: Fixed a problem when displaying some covers of .cbz files on the comic details page	2016-01-26 02:49:56 -05:00
API_REFERENCE	IMP: Updated the getUpcoming API method.	2016-11-02 11:14:02 -04:00
comictagger.py	FIX:(#1378 ) Failure to perform meta-tagging due to incorrect library reference, Updated CT to 1.20.1 to reflect the update	2016-09-07 19:08:43 -04:00
custom_exceptions_sample.csv	Added custom exceptions file to allow for user-based exceptions, as well as being able to maintain a base file in exceptions.csv	2012-10-20 03:51:17 -04:00
exceptions.csv	FIX: necessary git catchup (bad merge)	2013-10-01 14:37:42 -04:00
LICENSE	added LICENSE file for GPLv3	2017-10-12 12:03:36 -04:00
Mylar.py	OPDS Authentication, Cleanup, and Config Fixes	2017-10-31 13:41:44 -04:00
README.md	Update README.md	2016-06-08 10:55:44 -04:00
substitutes_sample.csv	IMP:(#559 ) Differences between pull-list naming and ComicVine - substitutions.csv usage, FIX:(#583 ) When Importing Series, if filenames had a volume label it would error out, FIX:(#597 ) When Importing Series, decimal in issue would cause error, FIX:(#600 ) Annuals file format now inluded as (thanks uspider7), IMP:(#571 ) centos-init.d and ubuntu-init.d added, Various other fixes....	2014-01-16 15:25:02 -05:00

README.md

Mylar is an automated Comic Book (cbr/cbz) downloader program heavily-based on the Headphones template and logic (which is also based on Sick-Beard).

Yes, it does work, yes there are still bugs, and for that reason I still consider it the definition of an 'Alpha Release'.

-REQUIREMENTS-

At least version 2.7.9 Python for proper usage (3.x is not supported).

                                               ** NEW ** 
             You will need to get your OWN ComicVine API Key for this application to fully work. 
                Failure to do this will result in limited (to No) ability when using Mylar.

To start it, type in 'python Mylar.py' from within the root of the mylar directory. Adding a --help option to the command will give a list of available options.

Once it's started, navigate to localhost:8090 in your web browser (or whatever IP the machine that has Mylar is on).

Here are some helpful hints hopefully:

Add a comic (series) using the Search button, or using the Pullist.
Make sure you specify Comic Location in the Configuration! (Mylar auto-creates the Comic Series directories under the Comic Location. The directory is displayed on the Comic Detail page).
If you make any Configuration changes, shutdown Mylar and restart it or else errors will occur - this is an outstanding bug.
You need to specify a search-provider in order to perform any search-related function!
In the Configuration section, if you enable 'Automatically Mark Upcoming Issues as Wanted' it will mark any NEW comic from the Pullist that is on your 'watchlist' as wanted.
There are times when adding a comic it will fail with an 'Error', submit a bug and it will be checked out (usually an easy fix).
For the most up-to-date build, use the Development build. Master doesn't get updated as frequently (> month), and Development is usually fairly stable.

The Mylar Forums are also online @ http://forum.mylarcomics.com

Please submit issues via git for any outstanding problems that need attention.

Post-Processing (Post-Processing is similar to the way SickBeard handles it.)

Within the post-processing/ folder of Mylar there are 2 files (autoProcessComics.py and autoProcessComics.cfg.sample)
Within the post-processing/ folder of Mylar there are 2 directories (nzbget, sabnzbd) and within each of these client folders, is a ComicRN.py script that is to be used with the respective download client.
Edit (put in your Mylar host, port, login and password (if required), and ssl(0 for no, 1 for yes) and rename the autoProcessComics.cfg.sample to autoProcessComics.cfg.
Copy autoProcessComics.py, autoProcessComics.cfg and the respective ComicRN.py into your SABnzbd/NZBGet scripts directory (or wherever your download client stores its scripts).
Make sure SABnzbd/NZBGet is setup to have a 'comic-related' category that points it to the ComicRN.py script that was just moved.
Ensure in Mylar that the category is named exactly the same.

Renaming

You can now specify Folder / File Formats.
Folder Format - if left blank, it will default to just using the default Comic Directory [ and creating subdirectories beneath in the format of ComicName-(Year) ] You can do multi-levels as well - so you could do $Publisher/$Series/$Year to have it setup like DC Comics/Batman/2011 (as an example)
File Format - if left blank, Mylar will use the original file and not rename at all. This includes replacing spaces, and zero suppression (both renaming features).
Folder Format IS used on every Add Series / Refresh Series request. Enabling Renaming has no bearing on this, so make sure if you're not using the default, that it's what you want.

Please help make it better, by sending in your bug reports / enhancement requests or just say what's working for you.

The Main page ...

The Search page ...

The Comic Detail page ...

The Pull page ...

The Config screen ...