mylar

Go to file

Cameron Savage b8bb7f14fc Updated README labeled sections with proper headers added link to API key clarified code input in "Usage" section cleaned up "Usage" section cleaned up "Renaming" section created a section for "Screenshots"		2019-03-29 12:32:54 -04:00
.github/ISSUE_TEMPLATE	Update issue templates for bug reporting	2019-01-29 11:23:39 -05:00
data	IMP: DDL Queue management now added (Manage tab / Manage DDL Queue) - restart / resume queue jobs, see active download in progress, history of ddl items with status and completion dates.	2019-03-29 11:17:43 -04:00
init-scripts	Misc typos in init-scripts/systemd/read.me	2019-01-29 11:36:30 -05:00
lib	FIX: Change qBt resume_all to a POST operation.	2019-02-12 10:13:14 -05:00
mylar	IMP: DDL Queue management now added (Manage tab / Manage DDL Queue) - restart / resume queue jobs, see active download in progress, history of ddl items with status and completion dates.	2019-03-29 11:17:43 -04:00
post-processing	FIX: Fix for autoProcessComics not properly determining the post-processing result type, Updated apc version to 2.04	2018-05-09 11:26:28 -04:00
screens	attempted fix for : and & in Comic Titles when adding	2012-09-13 11:27:34 -04:00
.gitignore	added settings.json to support vs code cause it's actually an ide	2019-02-19 14:38:15 -05:00
API_REFERENCE	Typo in API	2018-01-02 22:55:33 -05:00
LICENSE	added LICENSE file for GPLv3	2017-10-12 12:03:36 -04:00
Mylar.py	IMP: Added '-fs' (fixslashes) to maintenance mode to correct double-slashes incorrectly appearing within db Comic Location paths	2018-06-09 13:57:12 -04:00
README.md	Updated README	2019-03-29 12:32:54 -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
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).

This program is considered an "Alpha release". It is not bug-free, but it does work!

Requirements

At least Python version 2.7.9 (3.x is not supported)
ComicVine API key (found here - program will have limited to no functionality without it

Usage

To start the program, type python Mylar.py inside the root of the Mylar directory. Typing python Mykar.py --help 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).

Helpful hints:

Add a comic (series) using the Search button or the Pullist
Ensure Comic Location is specified in settings
- Mylar auto-creates the Comic Series directories under the Comic Location. The directory is displayed on the Comic Detail page).
Restart Mylar after any settings changes, or else errors will occur
A search provider needs to be specified to perform any search-related functions
Enabling 'Automatically Mark Upcoming Issues as Wanted' in settings will mark any NEW comic from the Pullist that is on your 'watchlist' as wanted
If adding a comic fails with "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 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 files and folders

You can now specify how Mylar creates the names of files and folders.

Folder Format

If left blank, it will default to just using the default Comic Directory
- Will create subdirectories in the format 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)
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.

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)

You can contribute by sending in your bug reports / enhancement requests. Telling us what's working for you helps too!

Screenshots

The Main page ...

The Search page ...

The Comic Detail page ...

The Pull page ...

The Config screen ...