toktokkie.metadata.book_series package¶

Subpackages¶

toktokkie.metadata.book_series.components package

Submodules¶

toktokkie.metadata.book_series.BookSeries module¶

class toktokkie.metadata.book_series.BookSeries.BookSeries(directory_path: str, json_data: Optional[Dict[str, Any]] = None, no_validation: bool = False)¶

Bases: toktokkie.metadata.base.Metadata.Metadata, toktokkie.metadata.book_series.BookSeriesRenamer.BookSeriesRenamer, toktokkie.metadata.book_series.BookSeriesPrompter.BookSeriesPrompter, toktokkie.metadata.book_series.BookSeriesValidator.BookSeriesValidator

Metadata class that handles book series

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

classmethod media_type() → toktokkie.enums.MediaType ¶

Returns: The Nook media type

classmethod valid_id_types() → List[toktokkie.enums.IdType]¶

Returns: A list of valid ID types

toktokkie.metadata.book_series.BookSeriesExtras module¶

class toktokkie.metadata.book_series.BookSeriesExtras.BookSeriesExtras¶

Bases: toktokkie.metadata.base.MetadataBase.MetadataBase, abc.ABC

Additional methods and attributes for book series metadata objects

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

property volumes¶

Returns: A list of book volumes for this book series

toktokkie.metadata.book_series.BookSeriesPrompter module¶

class toktokkie.metadata.book_series.BookSeriesPrompter.BookSeriesPrompter¶

Bases: toktokkie.metadata.base.Prompter.Prompter, toktokkie.metadata.book_series.BookSeriesExtras.BookSeriesExtras, abc.ABC

Implements the Prompter functionality for book series metadata

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

classmethod pre_prompt_check(directory_path: str)¶: Makes sure that the book series directory has at least one volume :param directory_path: The path to the directory to check :return: None

classmethod prompt(directory_path: str) → Dict[str, Any]¶

Generates new Metadata JSON using prompts for a directory :param directory_path: The path to the directory for which to generate

the metadata object

Returns: The generated metadata JSON

toktokkie.metadata.book_series.BookSeriesRenamer module¶

class toktokkie.metadata.book_series.BookSeriesRenamer.BookSeriesRenamer¶

Bases: toktokkie.metadata.base.Renamer.Renamer, toktokkie.metadata.book_series.BookSeriesExtras.BookSeriesExtras, abc.ABC

Implements the Renamer functionality for book series metadata

create_rename_operations() → List[toktokkie.metadata.base.components.RenameOperation.RenameOperation]¶: Creates renaming operations for book series metadata :return: The renaming operations

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶

resolve_title_name() → str¶: If possible, will fetch the appropriate name for the metadata based on IDs, falling back to the directory name if this is not possible or supported.

toktokkie.metadata.book_series.BookSeriesValidator module¶

class toktokkie.metadata.book_series.BookSeriesValidator.BookSeriesValidator¶

Bases: toktokkie.metadata.base.Validator.Validator, toktokkie.metadata.book_series.BookSeriesExtras.BookSeriesExtras, abc.ABC

Implements the Validator functionality for book series metadata

classmethod build_schema() → Dict[str, Any]¶: Generates the JSON schema :return: The JSON schema

directory_path: str¶: The path to the directory this metadata describes

json: Dict[str, Any]¶