Riki Official - Bible Summary Documentation
Documentation for bible-summary
The bible-summary package provides a comprehensive set of functions to interact with summaries of Bible chapters. Below is a detailed documentation of the available functions and their usage.
Links
Installation
pip install bible-summaryFunctions
_load_books()
Loads the book data from the JSON files in the package.
get_summary(book, chapter)
Returns the summary of a specific chapter in a given book.
get_summary('Genesis', '1')get_books()
Returns a list of all books available in the package.
get_books()get_chapters(book)
Returns a list of chapters for a given book.
get_chapters('Genesis')get_random_chapter(book=None, include_summary=True)
Returns a random chapter from a given book or from the whole Bible if no book is specified. Optionally includes the summary.
get_random_chapter('Genesis')get_random_category_chapter(category, include_summary=True)
Returns a random chapter from a given category (e.g., Gospels, Letters). Optionally includes the summary.
get_random_category_chapter('Gospels')get_max_chapters(book)
Returns the total number of chapters in a given book.
get_max_chapters('Genesis')get_summary_range(book, start_chapter, end_chapter)
Returns the summaries for a range of chapters in a given book.
get_summary_range('Genesis', 1, 5)get_all_chapters_summary(book)
Returns the summaries for all chapters in a given book.
get_all_chapters_summary('Genesis')search_summaries(keyword, book=None)
Searches for summaries containing a specific keyword. Optionally restricts the search to a given book.
search_summaries('creation', 'Genesis')get_categories()
Returns a list of all categories available in the package.
get_categories()get_random_chapter_by_category(category, include_summary=True)
Returns a random chapter from a given category. Optionally includes the summary.
get_random_chapter_by_category('Gospels')get_total_chapters()
Returns the total number of chapters in the Bible.
get_total_chapters()get_total_books()
Returns the total number of books in the Bible.
get_total_books()