Merge pull request #27 from tedivm/regex_docs

Document regex include/exclude options

Author: tedivm

README.md

@@ -73,7 +73,7 @@ from example_app.models import *
 
 ### Include or Exclude tables
 
-After importing the models, it is possible to select a subset of those models by using the `--exlude-tables` and `--include-tables` options.
+After importing the models, it is possible to select a subset of those models by using the `--exclude-tables` and `--include-tables` options.
 These are mutually exclusive options, the user can only provide inclusions or exclusions:
 
 ```bash
@@ -91,6 +91,14 @@ paracelsus graph example_app.models.base:Base \
   --include-tables "posts"
 ```
 
+You can also use regular expressions in the `include-tables` and `exclude-tables` options.
+
+```bash
+paracelsus graph example_app.models.base:Base \
+  --import-module "example_app.models.*" \
+  --exclude-tables "^com.*"
+```
+
 ### Specify Column Sort Order
 
 By default Paracelsus will sort the columns in all models such as primary keys are first, foreign keys are next and all other

paracelsus/cli.py

@@ -57,11 +57,11 @@ def graph(
     ] = [],
     exclude_tables: Annotated[
         List[str],
-        typer.Option(help="List of tables that are excluded from the graph"),
+        typer.Option(help="List of tables or regular expression patterns for tables that are excluded from the graph"),
     ] = [],
     include_tables: Annotated[
         List[str],
-        typer.Option(help="List of tables that are included in the graph"),
+        typer.Option(help="List of tables or regular expression patterns for tables that are included in the graph"),
     ] = [],
     python_dir: Annotated[
         List[Path],