mylar/README.md

67 lines
4.1 KiB
Markdown
Raw Normal View History

2012-10-30 17:37:56 +00:00
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'.
FIX:(#1222) Fixed usage with NZBHydra - will now be able to properly grab the nzb files, as well as proper logging and handling of Failed downloading, IMP: Duplicate Directory Dump option available in Configuration GUI. Any duplicates discovered during post-processing will be moved into this directory (if enabled) depending on the dupe constraints, FIX: Better handling of titles with '&' and '-' in the titles (as well as annuals) when adding series which should mean more accurate results when trying to add a series, FIX:(#1142) If files didn't have the pages field metadata within the comicinfo.xml file, would error out and either fail to display the issue, or fail to scan the issue during an import scan, FIX: When adding/refreshing a series, if the cover image from CV is unable to be retrieved or is not of an adequate size, fallback to a differnt quality image from CV, FIX: When refreshing/adding a series, annuals will only be checked against once (it was previously running through the entire annual check twice), FIX: During RSS scans/checks if a title in the results had an encoded & (&), would store it as the html which would never match up when doing actual comparison searches, IMP: Fixed usage of feedparser module in rss feeds so that it only uses the retrieved data and doesn't do the actual polling against the url (requests module now does), IMP: Added proper handling of error code 910 with dognzb (max api hits), so that once it hits the 910 error it will disable dognzb as a provider, FIX: When attempting to display issue details on a series detail page (the i icon in the issues table), if the metadata in the .cbz cannot be read or doesn't exist, will now display a graphical warning instead of a 500 error, IMP: Added fork/fork version/tag to comictagger user-agent/version, IMP: Removed configparser dependency from ComicTagger, FIX: When performing searches, improved volume label matching regardless of how the volume label is represented
2016-03-04 20:04:19 +00:00
-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.
2014-06-09 18:47:46 +00:00
Failure to do this will result in limited (to No) ability when using Mylar.
2012-09-17 06:03:14 +00:00
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!
2012-09-17 06:03:14 +00:00
(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!
2012-09-17 06:03:14 +00:00
- 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
2012-09-17 06:03:14 +00:00
2012-10-30 17:37:56 +00:00
Please submit issues via git for any outstanding problems that need attention.
Post-Processing
(Post-Processing is similar to the way SickBeard handles it.)
2012-10-30 17:37:56 +00:00
- 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.
2012-10-30 17:37:56 +00:00
- 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.
2012-10-30 17:37:56 +00:00
- 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) ]
2012-10-30 17:37:56 +00:00
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.
2012-10-30 17:37:56 +00:00
2012-09-17 06:03:14 +00:00
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](http://i.imgur.com/GLGMj.png)
The Search page ...
![preview thumb](http://i.imgur.com/EM21C.png)
The Comic Detail page ...
![preview thumb](http://i.imgur.com/6z5mH.png)
![preview thumb](http://i.imgur.com/ETuXp.png)
The Pull page ...
![preview thumb](http://i.imgur.com/VWTDQ.png)
The Config screen ...
![preview thumb](http://i.imgur.com/nQjIN.png)