okflint package

okflint — compliance linter for OKF documentary bases.

Deterministic quality-control tool (Ruff/mypy-style) for verifying that Markdown documents conform to the Open Knowledge Format standard.

Submodules

• okflint.audit module
  • AuditError
  • FileReport
    • FileReport.chars
    • FileReport.depth
    • FileReport.diagnostics
    • FileReport.frontmatter
    • FileReport.is_reserved
    • FileReport.lines
    • FileReport.markdown_links
    • FileReport.okf_status
    • FileReport.path
    • FileReport.split_candidate
    • FileReport.wikilinks
  • analyze_file()
  • compute_stats()
  • get_okf_status()
  • run_audit()
• okflint.cli module
  • build_parser()
  • main()
• okflint.cohesion module
  • CohesionResult
    • CohesionResult.components
    • CohesionResult.sections
  • Component
    • Component.section_indices
  • Section
    • Section.body
    • Section.level
    • Section.line
    • Section.title
    • Section.token_count
  • analyze_cohesion()
  • build_similarity_matrix()
  • compute_tfidf_vectors()
  • find_components()
  • merge_micro_sections()
  • split_into_sections()
  • tokenize()
• okflint.index module
  • IndexEntry
    • IndexEntry.description
    • IndexEntry.filename
    • IndexEntry.title
  • build_index_content()
  • generate_indexes()
• okflint.manifest module
  • BaseConfig
    • BaseConfig.external_refs
    • BaseConfig.name
    • BaseConfig.reserved_files
    • BaseConfig.roots
  • HygieneConfig
    • HygieneConfig.broken_links
    • HygieneConfig.legacy_forms
    • HygieneConfig.okf_v02_shapes
    • HygieneConfig.reserved_files
    • HygieneConfig.split
    • HygieneConfig.split_candidates
    • HygieneConfig.stale_content
    • HygieneConfig.unknown_fields
  • Manifest
    • Manifest.base
    • Manifest.hygiene
    • Manifest.okf_version
    • Manifest.profile
    • Manifest.resolved_okf_version
  • ManifestError
  • ProfileConfig
    • ProfileConfig.date_fields
    • ProfileConfig.types
  • RootConfig
    • RootConfig.exclude_patterns
    • RootConfig.path
  • SplitConfig
    • SplitConfig.exempt_paths
    • SplitConfig.exempt_types
    • SplitConfig.min_lines
    • SplitConfig.tau
  • TypeConfig
    • TypeConfig.aliases
    • TypeConfig.controlled_values
    • TypeConfig.optional
    • TypeConfig.required
  • load_manifest()
• okflint.scanner module
  • Header
    • Header.level
    • Header.line
    • Header.text
  • MarkdownLink
    • MarkdownLink.broken
    • MarkdownLink.is_external
    • MarkdownLink.target
    • MarkdownLink.text
  • WikiLink
    • WikiLink.alias
    • WikiLink.ambiguous
    • WikiLink.broken
    • WikiLink.raw
    • WikiLink.resolved_path
    • WikiLink.section
    • WikiLink.target
  • blank_code_spans()
  • build_file_index()
  • extract_headers()
  • extract_markdown_links()
  • extract_wikilinks()
  • parse_frontmatter()
• okflint.validate module
  • Diagnostic
    • Diagnostic.code
    • Diagnostic.file
    • Diagnostic.message
    • Diagnostic.severity
    • Diagnostic.tier
  • ManifestError
  • dispatch_reserved_file()
  • run_validate()
• okflint.vault module
  • BundleEntry
    • BundleEntry.manifest_path
    • BundleEntry.path
  • VaultConfig
    • VaultConfig.bundles
    • VaultConfig.name
    • VaultConfig.okf_vault_version
  • VaultError
  • load_vault()