Bauklotz Logo

Contents:

  • Getting Started with Bauklotz
  • User Guide
  • Python Guide
  • Reference
  • Python Reference
Bauklotz
  • Welcome to Bauklotz’s documentation!
  • View page source

Welcome to Bauklotz’s documentation!

Contents:

  • Getting Started with Bauklotz
    • What is Bauklotz?
    • Core Features
    • Quick Installation
    • Basic Usage Example
    • Next Steps
    • Pipeline Structure
    • Example Output
    • Common Use Cases
    • Where to Go Next
  • User Guide
    • Items
      • Core Concepts
      • Important Considerations
      • Pipeline Behavior
      • When to Use Facts
      • Warning
    • Filter
      • Core Concepts
      • Example Workflow
      • Benefits
    • Reports
      • Overview
      • Output Formats
      • Item Filtering
      • Example Use Case
    • Fact Checking
      • Overview
      • How It Works
      • Example Warning Output
      • CLI Option
      • Writing Fact-Aware Filters
      • See Also
  • Python Guide
    • Project Discovery
    • Statement count
    • Class and Methods
    • Imports
    • Filtering with labels
  • Reference
  • Python Reference
    • PythonProjectFilter
      • Key Features
      • Example Usage
      • Configuration
      • See Also
    • PythonSourceFile
      • Key Features
      • Example Usage
      • Properties
      • Methods
      • See Also
      • Notes
    • PythonProjectLocation
      • Key Features
      • Example Usage
      • Properties
      • Methods
      • See Also
      • Notes

User Guide Sections

  • Pipeline Configuration

  • Built-in Filters

  • Report Types

  • Plugin Development

  • Graph Visualization

API Reference

  • Core API

  • Filters API

  • Reports API

  • Plugin API

Examples

  • Basic Analysis

  • Custom Filters

  • Complex Pipelines

  • Plugin Creation

Contributing

  • Development Setup

  • Code Style

  • Testing

  • Documentation

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025, Patrick Daniel Greß <voidpointercast@justmail.de>.

Built with Sphinx using a theme provided by Read the Docs.