Generate README section for Lean configs (#551)

* Initial solution

* Update README

* Solve review comments

* Update readme.py script

Author: JosueNina

README.md

@@ -63,6 +63,21 @@ A locally-focused workflow (local development, local execution) with the CLI may
 4. Run `lean research "Project Name"` to start a Jupyter Lab session to perform research in.
 5. Run `lean backtest "Project Name"` to run a backtest whenever there's something to test. This runs your strategy in a Docker container containing the same packages as the ones used on QuantConnect.com, but with your own data.
 
+## CLI Configurations
+
+The following CLI configurations are available. Use the [`lean config list`](#lean-config-list) command to list them at any time.
+
+<!-- configuration table start -->
+| Key | Description |
+| --- | --- |
+| `user-id` | The user id used when making authenticated requests to the QuantConnect API. |
+| `api-token` | The API token used when making authenticated requests to the QuantConnect API. |
+| `default-language` | The default language used when creating new projects (allowed values: python, csharp). |
+| `engine-image` | The Docker image used when running the LEAN engine (quantconnect/lean:latest if not set). |
+| `research-image` | The Docker image used when running the research environment (quantconnect/research:latest if not set). |
+| `database-update-frequency` | How often the databases are updated. The format is DD.HH:MM:SS. If the frequency is less than a day can just be HH:MM:SS. Update can be disabled by setting this option to a non-date value (-, _, ..., etc.). If unset, default value is 1 day |
+<!-- configuration table end -->
+
 ## Commands
 
 *Note: the readme only contains the `--help` text of all commands. Visit the [documentation website](https://www.lean.io/docs/v2/lean-cli/key-concepts/getting-started) for more comprehensive documentation.*

scripts/readme.py

@@ -28,7 +28,7 @@
 from lean.commands import lean
 from lean.models.pydantic import WrappedBaseModel
 from lean.components.util.click_group_default_command import DefaultCommandGroup
-
+from lean.container import container
 
 class NamedCommand(WrappedBaseModel):
     name: str
@@ -71,8 +71,33 @@ def get_header_id(name: str) -> str:
     name = re.sub(r"[^a-zA-Z0-9-]", "", name)
     return name
 
+def get_configurations() -> List[dict]:
+    """Returns all available configurations with their keys and descriptions."""
+    config_manager = container.cli_config_manager
+    configurations = []
+
+    for option in config_manager.all_options:
+        configurations.append({
+            "key": option.key,
+            "description": option.description
+        })
+
+    return configurations
+
+def generate_configurations_table(configurations: List[dict]) -> str:
+    """Generates a Markdown table for the given configurations."""
+    table = ["| Key | Description |", "| --- | --- |"]
+
+    for config in configurations:
+        table.append(f"| `{config['key']}` | {config['description']} |")
+
+    return "\n".join(table)
+
 
 def main() -> None:
+    configurations = get_configurations()
+    configurations_table = generate_configurations_table(configurations)
+
     named_commands = get_commands(lean)
     named_commands = sorted(named_commands, key=lambda c: c.name)
 
@@ -96,14 +121,22 @@ def main() -> None:
         table_of_contents.append(f"- [`{c.name}`](#{get_header_id(c.name)})")
         command_sections.append("\n\n".join(filter(None, section_parts)))
 
-    full_text = "\n".join(table_of_contents) + "\n\n" + "\n\n".join(command_sections)
-    full_text = "\n".join(["<!-- commands start -->", full_text, "<!-- commands end -->"])
+    
+    configuration_text = "\n".join(["<!-- configuration table start -->", configurations_table, "<!-- configuration table end -->"])
+    commands_text = "\n".join(table_of_contents) + "\n\n" + "\n\n".join(command_sections)
+    commands_text = "\n".join(["<!-- commands start -->", commands_text, "<!-- commands end -->"])
 
     readme_path = Path.cwd() / "README.md"
     readme_content = readme_path.read_text(encoding="utf-8")
 
+    # CLI Configurations
+    readme_content = re.sub(r"<!-- configuration table start -->.*<!-- configuration table end -->",
+                            configuration_text,
+                            readme_content,
+                            flags=re.DOTALL)
+    # Commands
     readme_content = re.sub(r"<!-- commands start -->.*<!-- commands end -->",
-                            full_text,
+                            commands_text,
                             readme_content,
                             flags=re.DOTALL)
 
@@ -112,3 +145,4 @@ def main() -> None:
 
 if __name__ == "__main__":
     main()
+