mannou package¶

Subpackages¶

mannou.site package

Submodules¶

mannou.anilist module¶

Interraction module to AniList API.

mannou.api module¶

Main Mannou API.

This module provide the easy way to use mannou.anilist.AniList and mannou.mannou.Mannou.

Note

Every functions in this module are imported in main package mannou. If you want to use mannou.api.get function, you only need to type mannou.get.

Please use mannou.AniList and mannou.Mannou

mannou.cli module¶

Main Mannou API.

A command line interface for mannou. This command:

$ mannou

is as same as:

$ python3 -m mannou

Example

For downloading manga from ‘https://manganelo.com/manga/aiura’, from chapter 2 to 3, you can type:

$ mannou https://manganelo.com/manga/aiura --start 2 --end 3

For further feature, please type:

$ mannou --help

mannou.cli.main()¶

Main function.

This function will run if you type:

$ mannou

in your terminal.

mannou.cli.cli()¶: Main cli function.

mannou.exception module¶

Main exception module.

Every exception must be listed in here.

exception mannou.exception.ParserNotFoundError¶

Bases: Exception

Raise when url there is no parser found in mannou.Mannou.parsers.

mannou.mannou module¶

Main module for downloading manga.

mannou.parser module¶

Parser module for manga website.

This module is used for parsing manga website.

class mannou.parser.Image¶

Bases: tuple

Represent an image.

Parameters:	name (str) – The image name with extension. url (str) – The image source.

name¶: Alias for field number 0

url¶: Alias for field number 1

class mannou.parser.Chapter¶

Bases: tuple

Represent a chapter.

Parameters:	number (str) – The chapter number. str is used over int due there is some ‘decimal’ chapter, like 10.5. Why do not use float? It is weird to see chapter 1.0, I think. url (str) – The url of specific chapter.

number¶: Alias for field number 0

url¶: Alias for field number 1

class mannou.parser.Manga(url)¶

Bases: abc.ABC

An abstract base class for manga site parser.

Every parser class must inherit this class to ensure that every parser has the same functionality. The subclass also must has domain attribute to check whether url argument is valid url or not.

domain¶: str – Domain of the site

Parameters:	url (str) – Url of the manga. soup (`BeautifulSoup`) – BeautifulSoup object from url.
Raises:	`URLError` – If not url is not a valid url.

chapters¶: list of mannou.parser.Chapter – Available chapters.

classmethod check_url(url)¶

Check whether url is actually from self.domain or not.

Parameters:	url (str) – URL that you want to check.
Returns:	True if it is url from self.domain, False otherwise.
Return type:	bool

filter_chapters(start=0, stop=None)¶

Filter chapter in manga.

This is general algorithm for class parser that follow the rules. You may or may not override this method.

Parameters:	start (int, float, optional) – From what chapter? Default to 0. stop (int, float, optional) – What chapter to stop? default to None.
Returns:	Filtered chapters.
Return type:	`list` of `mannou.parser.Chapter`

get_chapter_images(chapter_url)¶

Parse chapter_url.

Returns:	:obj:`list` of (obj: mannou.parser.Image) – List of images name and source location. You can override this method as static method.

title¶: str – The title of manga

mannou.util module¶

Utility modules.

This module contains miscellaneous function used in every other packages and or modules.

Notes

If module grow complex, there is a chance to group similar function in the new modules.

mannou.util.mkdir(dirpath)¶

Create a directory.

Only create directory if dirpath is not exists. dirpath must be an object from pathlib.Path

Parameters:	dirpath (`pathlib.Path`) –
Returns:	True if successful, False otherwise.
Return type:	bool

mannou.util.clear_screen()¶

Clear terminal screen.

Only work for Windows and UNIX-like OS.

mannou.util.is_url(url)¶

Validate url.

Parameters:	url (str) – An url to validate.
Returns:	True if valid url, False otherwise.
Return type:	bool

mannou.util.get_200(url, max_retries=10, **options)¶

Sends GET request until it get 200.

By default, it will try 10 times before raise.

Parameters:	url (str) – URL that you want to GET max_retries (int, optional) – Decide how many times sending GET request before raise. user_agent (str, optional) – User agent that you want to use stream (bool, optional) – Decide if you want to stream or not.
Returns:
Return type:	`requests.Response`
Raises:	`HTTPError` – If max_retries exceeded.

mannou.util.make_soup(url)¶

Create bs4.BeautifulSoup object from url.

Parameters:	url (str) – URL that you want to scrap.
Returns:
Return type:	`bs4.BeautifulSoup`
Raises:	`exception.HTTPError` – From mannou.util.get_200

mannou.util.download(url, filepath)¶

Downloader, with progress bar.

Send GET request and save it to local computer.

Parameters:	url (str) – URL that you want to download. filepath (`str`) – Saved file location

class mannou.util.StatusCode¶

Bases: object

A bunch of HTTP status codes.

Every HTTP status code stored in readable attributes name.

INTERNAL_SERVER_ERROR = 500¶

NOT_FOUND = 404¶

OK = 200¶

Module contents¶

Mannou Manga Downloader¶

Mannou is a manga downloader for downloading manga from various sites. Basic usage:

>>> import mannou
>>> url = 'https://manganelo.com/manga/aiura'
>>> manga = mannou.get(url)
>>> str(manga) # or manga.title
Aiura
>>> manga[0] # or manga.chapters[0]
Chapter(number='1', url='https://manganelo.com/chapter/aiura/chapter_1')
>>> images = manga.get_chapter_images(manga[0].url)
>>> images[0]
Image(name='1.jpg', url='http://s8.mkklcdn.com/mangakakalot/a1/aiura/chapter_1/1.jpg')
>>> mannou.download(url, start=1, end=5) # Download every chapters 1 until 5 in 'Aiura' and save it to default location (~/Manga or %USERPROFILE%\Manga)

The other methods and properties are supported. Full documentation is at <https://mannou.readthedocs.io>.

Returns:	Parsed response from self.json.
Return type:	dict

Returns:	Response from API server in JSON format.
Return type:	str