Skip to content

CounterPillow/cum

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cum

Build Status codecov.io

comic updater, mangafied

Description

cum (comic updater, mangafied) is a tool designed for automated manga downloads from various online manga aggregate sites. Currently, the code is young and messy, so you should expect there to be issues and missing functionality. Please open up an issue on the tracker or submit a pull request to help out.

Installation

You can install cum on your system by executing python setup.py install. You can also execute the cum.py file directly, but it's not nearly as nice to use as the installed version. Please note that cum only supports Python 3.3+ at the moment.

Users of Arch Linux can install stable versions from the AUR.

Usage

To print out a list of available commands, use cum --help. For help with a particular command, use cum COMMAND --help.

Config

Config is stored at ~/.cum/config.json and is automatically created with default values when the program is ran for the first time.

{
  "batoto": {
    "cookie": "",  // Used to login to Batoto.
    "member_id": "",  // Used to login to Batoto.
    "pass_hash": "",  // Used to login to Batoto.
    "password": "",  // Password to use with Batoto logins.
    "username": ""  // Username to use with Batoto logins.
  }
  "cbz": false,  // If true, the archive extension will be .cbz instead of .zip.
  "compact_new": true,  // Uses compact listing mode for `cum new`.
  "download_directory": "/path/to/manga",  // Directory where manga is downloaded.
  "download_threads": 4,  // Maximum number of concurrent downloads.
  "html_parser": "html.parser",  // HTML parser used by cum.
  "madokami": {
    "password": "" // Password to use with Madokami
    "username": "", // Username to use with Madokami.
  }
}

Commands

alias      Assign a new alias to series.
chapters   List all chapters for a manga series.
download   Download all available chapters.
follow     Follow a series.
  --directory TEXT  Directory which download the series chapters into.
  --download        Downloads the chapters for the added follows.
  --ignore          Ignores the chapters for the added follows.
follows    List all follows.
get        Download chapters by URL or by alias:chapter.
  --directory TEXT  Directory which download chapters into.
ignore     Ignore chapters for a series.
new        List all new chapters.
open       Open the series URL in a browser.
repair-db  Runs an automated database repair.
unfollow   Unfollow manga.
unignore   Unignore chapters for a series.
update     Gather new chapters from followed series.

Examples

# Update the database with possible new chapters for followed series.
$ cum update

# List all new, non-ignored chapters.
$ cum new

# Add a follow for a manga series.
$ cum follow http://bato.to/comic/_/comics/gakkou-gurashi-r9554

# Print out the chapter list for the added series.
$ cum chapters gakkou-gurashi

# Ignore the first three chapters for the added series.
$ cum ignore gakkou-gurashi 2 3 1

# Change the alias for the added series.
$ cum alias gakkou-gurashi school-live

# Download all new, non-ignored chapters for the added series using the new alias.
$ cum download school-live

Supported sites

  • Batoto
    • Slow downloads
    • Account required
    • Reliable due to relatively standard naming format
  • Dynasty Reader
    • Moderate speed downloads
    • Account not required
    • Reliable downloads
  • Madokami
    • Fast downloads
    • Account required
    • Non-fixed format names for files combined with imperfect regex causes naming issues/exceptions

Dependencies

Community

There is an (inactive) IRC channel for cum: #cu on irc.rizon.net.

Design choices

  • File output format is partially based on Daiz's Manga Naming Scheme.
    • The full format would be a nightmare to get working with the sparse information available on scraper sites.
  • Code styling is based on Pocoo Style Guide with 79 character line limit.

About

comic updater, mangafied

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%