Sync doc Python SDK from infrahub repo

docs/docs-python-sdk/infrahubctl/infrahubctl-branch.mdx

@@ -0,0 +1,138 @@
+# `infrahubctl branch`
+
+Manage the branches in a remote Infrahub instance.
+
+List, create, merge, rebase ..
+
+**Usage**:
+
+```console
+$ infrahubctl branch [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `create`: Create a new branch.
+* `delete`: Delete a branch.
+* `list`: List all existing branches.
+* `merge`: Merge a Branch with main.
+* `rebase`: Rebase a Branch with main.
+* `validate`: Validate if a branch has some conflict and...
+
+## `infrahubctl branch create`
+
+Create a new branch.
+
+**Usage**:
+
+```console
+$ infrahubctl branch create [OPTIONS] BRANCH_NAME
+```
+
+**Arguments**:
+
+* `BRANCH_NAME`: Name of the branch to create  [required]
+
+**Options**:
+
+* `--description TEXT`: Description of the branch
+* `--sync-with-git / --no-sync-with-git`: Extend the branch to Git and have Infrahub create the branch in connected repositories.  [default: no-sync-with-git]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl branch delete`
+
+Delete a branch.
+
+**Usage**:
+
+```console
+$ infrahubctl branch delete [OPTIONS] BRANCH_NAME
+```
+
+**Arguments**:
+
+* `BRANCH_NAME`: [required]
+
+**Options**:
+
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl branch list`
+
+List all existing branches.
+
+**Usage**:
+
+```console
+$ infrahubctl branch list [OPTIONS]
+```
+
+**Options**:
+
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl branch merge`
+
+Merge a Branch with main.
+
+**Usage**:
+
+```console
+$ infrahubctl branch merge [OPTIONS] BRANCH_NAME
+```
+
+**Arguments**:
+
+* `BRANCH_NAME`: [required]
+
+**Options**:
+
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl branch rebase`
+
+Rebase a Branch with main.
+
+**Usage**:
+
+```console
+$ infrahubctl branch rebase [OPTIONS] BRANCH_NAME
+```
+
+**Arguments**:
+
+* `BRANCH_NAME`: [required]
+
+**Options**:
+
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
+## `infrahubctl branch validate`
+
+Validate if a branch has some conflict and is passing all the tests (NOT IMPLEMENTED YET).
+
+**Usage**:
+
+```console
+$ infrahubctl branch validate [OPTIONS] BRANCH_NAME
+```
+
+**Arguments**:
+
+* `BRANCH_NAME`: [required]
+
+**Options**:
+
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-check.mdx

@@ -0,0 +1,26 @@
+# `infrahubctl check`
+
+Execute user-defined checks.
+
+**Usage**:
+
+```console
+$ infrahubctl check [OPTIONS] [CHECK_NAME] [VARIABLES]...
+```
+
+**Arguments**:
+
+* `[CHECK_NAME]`: Name of the Python check
+* `[VARIABLES]...`: Variables to pass along with the query. Format key=value key=value.
+
+**Options**:
+
+* `--branch TEXT`
+* `--path TEXT`: Root directory  [default: .]
+* `--debug / --no-debug`: [default: no-debug]
+* `--format-json / --no-format-json`: [default: no-format-json]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--list`: Show available Python checks
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-dump.mdx

@@ -0,0 +1,23 @@
+# `infrahubctl dump`
+
+Export nodes and their relationships out of the database.
+
+**Usage**:
+
+```console
+$ infrahubctl dump [OPTIONS]
+```
+
+**Options**:
+
+* `--namespace TEXT`: Namespace(s) to export
+* `--directory PATH`: Directory path to store export  [default: (dynamic)]
+* `--quiet / --no-quiet`: No console output  [default: no-quiet]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--branch TEXT`: Branch from which to export  [default: main]
+* `--concurrent INTEGER`: Maximum number of requests to execute at the same time.  [env var: INFRAHUB_MAX_CONCURRENT_EXECUTION; default: 4]
+* `--timeout INTEGER`: Timeout in sec  [env var: INFRAHUB_TIMEOUT; default: 60]
+* `--exclude TEXT`: Prevent node kind(s) from being exported, CoreAccount is excluded by default  [default: CoreAccount]
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-generator.mdx

@@ -0,0 +1,25 @@
+# `infrahubctl generator`
+
+Run a generator script.
+
+**Usage**:
+
+```console
+$ infrahubctl generator [OPTIONS] [GENERATOR_NAME] [VARIABLES]...
+```
+
+**Arguments**:
+
+* `[GENERATOR_NAME]`: Name of the Generator
+* `[VARIABLES]...`: Variables to pass along with the query. Format key=value key=value.
+
+**Options**:
+
+* `--branch TEXT`
+* `--path TEXT`: Root directory  [default: .]
+* `--debug / --no-debug`: [default: no-debug]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--list`: Show available Generators
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-info.mdx

@@ -0,0 +1,17 @@
+# `infrahubctl info`
+
+Display the status of the Python SDK.
+
+**Usage**:
+
+```console
+$ infrahubctl info [OPTIONS]
+```
+
+**Options**:
+
+* `--detail / --no-detail`: Display detailed information.  [default: no-detail]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-load.mdx

@@ -0,0 +1,22 @@
+# `infrahubctl load`
+
+Import nodes and their relationships into the database.
+
+**Usage**:
+
+```console
+$ infrahubctl load [OPTIONS]
+```
+
+**Options**:
+
+* `--directory PATH`: Directory path of exported data  [default: (dynamic)]
+* `--continue-on-error / --no-continue-on-error`: Allow exceptions during loading and display them when complete  [default: no-continue-on-error]
+* `--quiet / --no-quiet`: No console output  [default: no-quiet]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--branch TEXT`: Branch from which to export  [default: main]
+* `--concurrent INTEGER`: Maximum number of requests to execute at the same time.  [env var: INFRAHUB_MAX_CONCURRENT_EXECUTION]
+* `--timeout INTEGER`: Timeout in sec  [env var: INFRAHUB_TIMEOUT; default: 60]
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-menu.mdx

@@ -0,0 +1,40 @@
+# `infrahubctl menu`
+
+Manage the menu in a remote Infrahub instance.
+
+**Usage**:
+
+```console
+$ infrahubctl menu [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `load`: Load one or multiple menu files into...
+
+## `infrahubctl menu load`
+
+Load one or multiple menu files into Infrahub.
+
+**Usage**:
+
+```console
+$ infrahubctl menu load [OPTIONS] MENUS...
+```
+
+**Arguments**:
+
+* `MENUS...`: [required]
+
+**Options**:
+
+* `--debug / --no-debug`: [default: no-debug]
+* `--branch TEXT`: Branch on which to load the menu.  [default: main]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-object.mdx

@@ -0,0 +1,40 @@
+# `infrahubctl object`
+
+Manage objects in a remote Infrahub instance.
+
+**Usage**:
+
+```console
+$ infrahubctl object [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `load`: Load one or multiple objects files into...
+
+## `infrahubctl object load`
+
+Load one or multiple objects files into Infrahub.
+
+**Usage**:
+
+```console
+$ infrahubctl object load [OPTIONS] PATHS...
+```
+
+**Arguments**:
+
+* `PATHS...`: [required]
+
+**Options**:
+
+* `--debug / --no-debug`: [default: no-debug]
+* `--branch TEXT`: Branch on which to load the objects.  [default: main]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-protocols.mdx

@@ -0,0 +1,20 @@
+# `infrahubctl protocols`
+
+Export Python protocols corresponding to a schema.
+
+**Usage**:
+
+```console
+$ infrahubctl protocols [OPTIONS]
+```
+
+**Options**:
+
+* `--schemas PATH`: List of schemas or directory to load.
+* `--branch TEXT`: Branch of schema to export Python protocols for.
+* `--sync / --no-sync`: Generate for sync or async.  [default: no-sync]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--out TEXT`: Path to a file to save the result.  [default: schema_protocols.py]
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.

docs/docs-python-sdk/infrahubctl/infrahubctl-render.mdx

@@ -0,0 +1,25 @@
+# `infrahubctl render`
+
+Render a local Jinja2 Transform for debugging purpose.
+
+**Usage**:
+
+```console
+$ infrahubctl render [OPTIONS] [TRANSFORM_NAME] [VARIABLES]...
+```
+
+**Arguments**:
+
+* `[TRANSFORM_NAME]`: Name of the Python transformation
+* `[VARIABLES]...`: Variables to pass along with the query. Format key=value key=value.
+
+**Options**:
+
+* `--branch TEXT`: Branch on which to render the transform.
+* `--debug / --no-debug`: [default: no-debug]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--list`: Show available transforms
+* `--out TEXT`: Path to a file to save the result.
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.