Welcome to Clypher’s documentation!

Quick Summary

• Introduction to Clypher
• Getting Started
  • Installation
  • CLI Usage
    • Specifying input files
      • Recursively adding input files
    • Specifying an output directory
    • Specifying a password
    • Overwriting files
    • Specifying an engine

Inner Workings

• How Clypher Works
  • TL;DR
• The CLI
  • The ConsoleManager
  • The ProgressManager
• Engines
  • The BaseEngine class
    • BaseEngine
      • BaseEngine.plaintext_password
      • BaseEngine.infiles
      • BaseEngine.output
      • BaseEngine.force_ow
      • BaseEngine.start_encryption()
      • BaseEngine.start_decryption()
  • How an Engine operates
  • How Engines get imported
  • Creating new engines
• File Handlers
  • The BaseFileHandler class
    • BaseFileHandler
      • BaseFileHandler.file_list
      • BaseFileHandler.out
      • BaseFileHandler.force_ow
      • BaseFileHandler.list_files()
      • BaseFileHandler.request()
      • BaseFileHandler.write()
  • Adding new File Handlers
• Encryptors
  • The BaseEncryptor class
    • BaseEncryptor
      • BaseEncryptor.password
      • BaseEncryptor.encrypt()
      • BaseEncryptor.decrypt()
• Logging
  • The get_logger_or_debug() function

Concrete Implementations

• The FernetEngine
  • The FernetEncryptor
  • The FileHandler