clic package

Subpackages

• clic.db package
  • Submodules
    • clic.db.book: Fetch/store book dicts to DB
    • book_hash()
    • get_book()
    • put_book()
    • clic.db.book_metadata: Fetch additional book information
      • get_book_metadata
        • book_titles
        • chapter_start
        • word_count_chapter
        • word_count_quote
    • get_book_metadata()
    • clic.db.corpora: Resolve corpora lists
      • corpora_to_book_ids
        • book name
        • author
        • corpus name
        • old names
    • corpora_to_book_ids()
    • clic.db.corpora: Get/put corpora dicts to DB
    • put_corpus()
    • clic.db.lookup: Translate forms of region class
    • API_SUBSETS
    • api_subset_lookup()
    • rclass_id_lookup()
  • Module contents
• clic.migrate package
  • Submodules
    • clic.migrate.corpora_repo: Import books from the CCR corpora repository
    • export_book()
    • get_corpora_for()
    • import_book()
    • parse_corpora_bib()
    • script_import_corpora_repo()
    • script_region_export()
    • to_region_file()
    • clic.migrate.region_preview: Mark up regions in text with ANSI colour codes
    • colourise_book()
    • region_preview()
    • script_region_preview()
  • Module contents
• clic.region package
  • Submodules
    • clic.region.chapter: Tag chapter.* regions
      • chapter.title / chapter.text regions
      • chapter.part regions
      • chapter.paragraph / chapter.sentence regions
    • tagger_chapter()
    • tagger_chapter_paragraph()
    • tagger_chapter_part()
    • tagger_chapter_sentence()
    • tagger_chapter_text()
    • tagger_chapter_title()
    • clic.region.metadata: Tag metadata.* regions
      • metadata.title / metadata.author regions
    • tagger_metadata()
    • clic.region.quote: Tag quote.* regions
      • quote.quote / quote.nonquote regions
      • quote.embedded regions
    • is_quote()
    • tagger_quote()
    • tagger_quote_nonquote()
    • tagger_quote_quote()
    • clic.region.suspension: Tag quote.suspension.* regions
      • quote.suspension regions
    • tagger_quote_suspension()
    • clic.region.tag: Tag a book with all region taggers
    • tagger()
    • clic.region.utils: Internal utilities for tagging
    • region_append_without_whitespace()
    • regions_flatten()
    • regions_invert()
    • regions_unflatten()
  • Module contents

Submodules

• clic.cluster: Cluster endpoint
  • Method
  • Examples / edge cases
• cluster()
• get_word_list()
• clic.count: Word count endpoint
  • Method
  • Examples / edge cases
• count()
• clic.errors: Error objects returned by API
• UserError
• clic.icuconfig: Global locale used for ICU
• clic.keyword: Keyword endpoint
  • Usage as follows:
  • Or using text files as input:
• extract_keywords()
• facets_to_df()
• keyword()
• log_likelihood()
• clic.metadata: Metadata endpoint
• corpora()
• corpora_headlines()
• corpora_image()
• clic.stream_json: Wrapper to stream JSON arrays to client
• JSONEncoder
  • JSONEncoder.default()
• format_error()
• stream_json()
• clic.text: Text endpoint
• text()
• clic.tokenizer: Tokenize strings to types
  • Method
  • Examples / edge cases
• INITIAL_ABBREVIATIONS
• types_from_string()
• word_boundary_type()

Module contents