### Installation Source: https://github.com/tedivm/paracelsus/blob/main/README.md Installs the paracelsus package using pip. ```bash pip install paracelsus ``` -------------------------------- ### Paracelsus Configuration in pyproject.toml Source: https://github.com/tedivm/paracelsus/blob/main/README.md Example of basic Paracelsus configuration settings within a pyproject.toml file. ```toml [tool.paracelsus] base = "example.base:Base" imports = [ "example.models" ] ``` -------------------------------- ### Inject Mermaid Diagrams into Markdown Source: https://github.com/tedivm/paracelsus/blob/main/README.md Example of injecting generated Mermaid diagrams directly into markdown files. ```bash paracelsus inject db/README.md example_app.models.base:Base --import-module "example_app.models:*" ``` -------------------------------- ### Advanced Paracelsus Configuration in pyproject.toml Source: https://github.com/tedivm/paracelsus/blob/main/README.md Example of advanced Paracelsus configuration options in pyproject.toml, including excludes, sorting, and type parameter delimiters. ```toml [tool.paracelsus] base = "example.base:Base" imports = [ "example.models" ] exclude_tables = [ "comments" ] column_sort = "preserve-order" omit_comments = false max_enum_members = 10 type_parameter_delimiter = "-" # Default is hyphen, cannot contain commas or spaces ``` -------------------------------- ### Customizing Type Parameter Delimiter Source: https://github.com/tedivm/paracelsus/blob/main/README.md Example of how to customize the delimiter for type parameters in SQLAlchemy column types when generating diagrams. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.users" \ --type-parameter-delimiter "_" ``` -------------------------------- ### CLI Help Source: https://github.com/tedivm/paracelsus/blob/main/docs/dev/cli.md Displays the full help contents of the Paracelsus CLI. ```bash paracelsus --help ``` -------------------------------- ### Using an Alternative Configuration File Source: https://github.com/tedivm/paracelsus/blob/main/README.md Demonstrates how to specify an alternative TOML configuration file for Paracelsus using the --config flag. ```bash paracelsus graph --config path/to/alternative_pyproject.toml ``` -------------------------------- ### Importing Models Source: https://github.com/tedivm/paracelsus/blob/main/README.md Imports specified SQLAlchemy models using the --import-module flag. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.users" \ --import-module "example_app.models.posts" \ --import-module "example_app.models.comments" ``` -------------------------------- ### Wildcard Import Source: https://github.com/tedivm/paracelsus/blob/main/README.md Imports all models from a module using a wildcard. ```bash paracelsus graph example_app.models.base:Base --import-module "example_app.models:*" ``` -------------------------------- ### Check for Changes Before Injecting Diagrams Source: https://github.com/tedivm/paracelsus/blob/main/README.md Using the --check flag to verify if documentation needs updating before making changes. ```bash paracelsus inject db/README.md example_app.models.base:Base --import-module "example_app.models:*" --check ``` -------------------------------- ### Create PNG Image from DOT Graph Source: https://github.com/tedivm/paracelsus/blob/main/README.md Command to convert a DOT graph generated by Paracelsus into a PNG file using GraphViz's dot tool. ```bash paracelsus graph example_app.models.base:Base --import-module "example_app.models:*" --format dot | dot -Tpng > output.png ``` -------------------------------- ### Include Tables Alternative Source: https://github.com/tedivm/paracelsus/blob/main/README.md Includes specific tables in the generated diagram. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.*" \ --include-tables "users" \ --include-tables "posts" ``` -------------------------------- ### Default Column Sort Order Source: https://github.com/tedivm/paracelsus/blob/main/README.md Demonstrates the default column sort order (key-based). ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.users" \ ``` -------------------------------- ### Create SVG Image from DOT Graph Source: https://github.com/tedivm/paracelsus/blob/main/README.md Command to convert a DOT graph generated by Paracelsus into an SVG file using GraphViz's dot tool. ```bash paracelsus graph example_app.models.base:Base --import-module "example_app.models:*" --format dot | dot -Tsvg > output.svg ``` -------------------------------- ### Include or Exclude Tables Source: https://github.com/tedivm/paracelsus/blob/main/README.md Excludes specific tables from the generated diagram. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.*" \ --exclude-tables "comments" ``` -------------------------------- ### Explicit Default Column Sort Order Source: https://github.com/tedivm/paracelsus/blob/main/README.md Explicitly sets the column sort order to key-based. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.users" \ --column-sort key-based ``` -------------------------------- ### Exclude Tables with Regex Source: https://github.com/tedivm/paracelsus/blob/main/README.md Excludes tables matching a regular expression. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.*" \ --exclude-tables "^com.*" ``` -------------------------------- ### Preserve Column Order Source: https://github.com/tedivm/paracelsus/blob/main/README.md Sets the column sort order to preserve the order of fields in the models. ```bash paracelsus graph example_app.models.base:Base \ --import-module "example_app.models.users" \ --column-sort preserve-order ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.