clic package

Subpackages

• clic.db package
  • Submodules
    • clic.db.book: Fetch/store book dicts to DB
    • clic.db.book_metadata: Fetch additional book information
      • get_book_metadata
        • book_titles
        • chapter_start
        • word_count_chapter
        • word_count_quote
    • clic.db.corpora: Resolve corpora lists
      • corpora_to_book_ids
        • book name
        • author
        • corpus name
        • old names
    • clic.db.corpora: Get/put corpora dicts to DB
    • clic.db.cursor: Connect to CLiC DB
    • clic.db.lookup: Translate forms of region class
    • clic.db.version: Get/set corpora version in DB
  • Module contents
• clic.migrate package
  • Submodules
    • clic.migrate.cheshire_json: Import books from a CLiC 1.7 instance
    • clic.migrate.corpora_repo: Import books from the CCR corpora repository
    • clic.migrate.region_preview: Mark up regions in text with ANSI colour codes
  • 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
    • clic.region.metadata: Tag metadata.* regions
      • metadata.title / metadata.author regions
    • clic.region.quote: Tag quote.* regions
      • quote.quote / quote.nonquote regions
      • quote.embedded regions
    • clic.region.suspension: Tag quote.suspension.* regions
      • quote.suspension regions
    • clic.region.tag: Tag a book with all region taggers
    • clic.region.utils: Internal utilities for tagging
  • Module contents

Submodules

• clic.app: CLiC Flask application
• clic.cluster: Cluster endpoint
  • Method
  • Examples / edge cases
• clic.concordance: Concordance endpoint
  • Query (q parameter) format
  • Examples
  • Method
  • Examples / edge cases
  • Examples: subset selection
  • Query parsing
• clic.count: Word count endpoint
  • Method
  • Examples / edge cases
• clic.errors: Error objects returned by API
• clic.icuconfig: Global locale used for ICU
• clic.keyword: Keyword endpoint
  • Usage as follows:
  • Or using text files as input:
• clic.metadata: Metadata endpoint
• clic.stream_json: Wrapper to stream JSON arrays to client
• clic.subset: Subset endpoint
  • Method
  • Examples / edge cases
• clic.text: Text endpoint
• clic.tokenizer: Tokenize strings to types
  • Method
  • Examples / edge cases

Module contents