src.backend.lib.library.Catalogue Class Reference

Inheritance diagram for src.backend.lib.library.Catalogue:

Public Member Functions
	__init__ (self, config)
	scan_folder (self, _path=None)
	filter_books (self)
	process_by_filetype (self, book)
	extract_metadata_epub (self, book)
	extract_metadata_pdf (self, book)
	extract_metadata_mobi (self, book)
	extract_content (self, book_zip, book)
	extract_cover_html (self, book_zip, book)
	extract_cover_image (self, book_zip, book)
	compare_shelf_current (self)
	import_books (self, list=None, **kwargs)

Static Public Member Functions
	process_epub (book)
	stripTags (source)

Public Attributes
list	file_list = []
	opf_regx = re.compile(r"\.opf")
	cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif")
	html_regx = re.compile(r"\.html")
	title_sanitization_regx = re.compile(r"^(Book )+[0-9]*")
	title_sanitization_lvl2_regx
	title_sanitization_dirs_regx = re.compile(r"/")
	root_dir = config.root
	book_folder = config.book_path
	books = None
	db_pointer = config.catalogue_db
	config = config

Detailed Description

Decodes book metadata for storage

Constructor & Destructor Documentation

__init__()

src.backend.lib.library.Catalogue.__init__	(		self,
			config )

Member Function Documentation

compare_shelf_current()

src.backend.lib.library.Catalogue.compare_shelf_current

(

self

)

Calls storage system, gets list of books stored and compares against files on disk

extract_content()

src.backend.lib.library.Catalogue.extract_content	(		self,
			book_zip,
			book )

Opens epub as zip file filters then stores as list any files matching opf_regx

extract_cover_html()

src.backend.lib.library.Catalogue.extract_cover_html	(		self,
			book_zip,
			book )

Opens epub as zip file filters then stores as list any files matching html_regx

extract_cover_image()

src.backend.lib.library.Catalogue.extract_cover_image	(		self,
			book_zip,
			book )

Opens epub as zip file filters then stores as list any files matching cover_regx

extract_metadata_epub()

src.backend.lib.library.Catalogue.extract_metadata_epub	(		self,
			book )

Extract metadata from epub file

:param book: Dictionary of epub file contents
:returns: Dictionary of book metadata

extract_metadata_mobi()

src.backend.lib.library.Catalogue.extract_metadata_mobi	(		self,
			book )

extract_metadata_pdf()

src.backend.lib.library.Catalogue.extract_metadata_pdf	(		self,
			book )

Return extracted metadata
:NOTES: Retrieval of data has been problematic, some pdf's providing
reliable titles that corespond with the actual, and others being
nonsense.

filter_books()

src.backend.lib.library.Catalogue.filter_books

(

self

)

Calls scan_folder and filters out book files.

:returns self._book_list_expanded: json string containing
all book metadata

Reimplemented in src.backend.tests.library_test.Test_Catalogue.

import_books()

src.backend.lib.library.Catalogue.import_books	(		self,
			list = None,
		**	kwargs )

Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.

Reimplemented in src.backend.lib.overide.ACatalogue.

process_by_filetype()

src.backend.lib.library.Catalogue.process_by_filetype	(		self,
			book )

Determine books filetype and process.

process_epub()

src.backend.lib.library.Catalogue.process_epub ( book )

static

Return dictionary of epub file contents

scan_folder()

src.backend.lib.library.Catalogue.scan_folder	(		self,
			_path = None )

Scan folder by _path, allows recurisive scanning

:param _path: Path to scan

Reimplemented in src.backend.lib.overide.ACatalogue.

stripTags()

src.backend.lib.library.Catalogue.stripTags ( source )

static

Member Data Documentation

book_folder

src.backend.lib.library.Catalogue.book_folder = config.book_path

books

src.backend.lib.library.Catalogue.books = None

config

src.backend.lib.library.Catalogue.config = config

cover_regx

src.backend.lib.library.Catalogue.cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif")

db_pointer

src.backend.lib.library.Catalogue.db_pointer = config.catalogue_db

file_list

list src.backend.lib.library.Catalogue.file_list = []

html_regx

src.backend.lib.library.Catalogue.html_regx = re.compile(r"\.html")

opf_regx

src.backend.lib.library.Catalogue.opf_regx = re.compile(r"\.opf")

root_dir

src.backend.lib.library.Catalogue.root_dir = config.root

title_sanitization_dirs_regx

src.backend.lib.library.Catalogue.title_sanitization_dirs_regx = re.compile(r"/")

title_sanitization_lvl2_regx

src.backend.lib.library.Catalogue.title_sanitization_lvl2_regx

Initial value:

=  re.compile(
                r"^(Book )+[0-9]*\W+(-)")

title_sanitization_regx

src.backend.lib.library.Catalogue.title_sanitization_regx = re.compile(r"^(Book )+[0-9]*")

---

The documentation for this class was generated from the following file:

• src/backend/lib/library.py