Go to file
evilhero d167f9795a FIX: Fail to scan in issues if no year present within filename (Recheck Files option) 2015-06-12 02:39:27 -04:00
bs4 IMP: Torrent Integration with CBT and KAT, IMP: RSS Feed Integration, IMP: Multiple Alternate Search Names, IMP: Newznab Provider Name Field, FIX:(#475) Metatagging not changing status, FIX:(#468) Covers not displaying in FF, FIX:(#469)(#459) NZB Search Scan Error, FIX: (#467) Annuals not found ... too many to list. 2013-07-30 00:57:37 -04:00
cache IMP: Torrent Integration with CBT and KAT, IMP: RSS Feed Integration, IMP: Multiple Alternate Search Names, IMP: Newznab Provider Name Field, FIX:(#475) Metatagging not changing status, FIX:(#468) Covers not displaying in FF, FIX:(#469)(#459) NZB Search Scan Error, FIX: (#467) Annuals not found ... too many to list. 2013-07-30 00:57:37 -04:00
cherrypy attempted fix for : and & in Comic Titles when adding 2012-09-13 11:27:34 -04:00
data FIX:(#1039)(#1036) Problems sending files to SABnzbd when Mylar & SABnzbd are on seperate machines. Will now download the nzb, verify it, then send to SABnzbd via internal Mylar API, IMP: Seperated the SABnzbd Download Directory option within the Configuration to indicate is only required when Mylar and SABnzbd are on seperate machines, FIX:(#1037) Unable to retrieve Download URL when using NZBMegaSearch as a provider, IMP:(#1033) Story Arc issues downloaded via torrents/nzbs/outside of Mylar can now be manually post-processed into correct Story Arcs, as well as being downloaded directly via SAB/NZBget, FIX: Retrying a Snatched Download from either the History or Series Detail page should now be working, FIX:(#1042) Changed script source to relative URL for jquery-1.9.1.js, IMP: Start of small code clean-up 2015-06-06 21:44:46 -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: Upgraded requests to 2.7.0 2015-05-19 13:38:36 -04:00
mako attempted fix for : and & in Comic Titles when adding 2012-09-13 11:27:34 -04:00
mylar FIX: Fail to scan in issues if no year present within filename (Recheck Files option) 2015-06-12 02:39:27 -04:00
post-processing FIX: nzbget post-processing with ComicRN was spamming incorrect version on every post-processing run. 2015-05-19 13:35:54 -04:00
screens attempted fix for : and & in Comic Titles when adding 2012-09-13 11:27:34 -04:00
.gitignore remove auth for /cache, added getArt 2015-03-05 13:57:12 -05:00
API_REFERENCE Add downloadIssue to api 2015-05-21 11:53:35 -04:00
Mylar.py Whitespace cleanup 2015-05-27 00:43:43 -04:00
README.md FIX: updated README to indicate new post-processing folder structure, FIX: Added .AppleDouble to .gitignore for future PR's 2014-10-13 15:54:24 -04:00
comictagger.py Whitespace cleanup 2015-05-27 00:43: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
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 reson I still consider it the definition of an 'Alpha Release'.

This application requires a version of the 2.7.x Python branch for the best results (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 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 it's 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 ... preview thumb

The Search page ... preview thumb

The Comic Detail page ... preview thumb preview thumb

The Pull page ... preview thumb

The Config screen ... preview thumb