diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 000000000..56c8ab4f3 --- /dev/null +++ b/docs/cli.md @@ -0,0 +1,7 @@ +# Commands + + +::: mkdocs-click + :module: warren.cli + :command: cli + :depth: 1 diff --git a/docs/pyproject.toml b/docs/pyproject.toml index 22cbd0dc4..58b6ff0da 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -28,10 +28,12 @@ license = {file = "LICENSE.md"} keywords = ["Analytics", "xAPI", "LRS", "LTI"] dependencies = [ "mike==2.1.1", + "mkdocs-click==0.8.1", "mkdocs-material==9.5.27", "mkdocs==1.6.0", "neoteroi-mkdocs==1.0.5", "pymdown-extensions==10.8.1", + "warren-api", ] [project.urls] diff --git a/mkdocs.yml b/mkdocs.yml index 73e18c538..7516442b8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,6 +49,7 @@ theme: markdown_extensions: - admonition - attr_list + - mkdocs_click - smarty - toc: permalink: True @@ -71,6 +72,7 @@ markdown_extensions: nav: - "Warren": index.md + - "CLI": cli.md - "Plugins": plugins.md - "Warren-TdBP": tdbp.md - "Contributing": contribute.md diff --git a/src/api/core/warren/conf.py b/src/api/core/warren/conf.py index cfb9b33b0..9c59c00e2 100644 --- a/src/api/core/warren/conf.py +++ b/src/api/core/warren/conf.py @@ -22,9 +22,9 @@ class Settings(BaseSettings): DEBUG: bool = False # LRS backend - LRS_HOSTS: Union[List[AnyHttpUrl], AnyHttpUrl] - LRS_AUTH_BASIC_USERNAME: str - LRS_AUTH_BASIC_PASSWORD: str + LRS_HOSTS: Union[List[AnyHttpUrl], AnyHttpUrl] = "http://ralph:8200" # type: ignore + LRS_AUTH_BASIC_USERNAME: str = "ralph" + LRS_AUTH_BASIC_PASSWORD: str = "secret" # Warren server SERVER_PROTOCOL: str = "http" @@ -65,8 +65,8 @@ class Settings(BaseSettings): API_TEST_DB_NAME: str = "test-warren-api" # Token - APP_SIGNING_ALGORITHM: str - APP_SIGNING_KEY: str + APP_SIGNING_ALGORITHM: str = "HS256" + APP_SIGNING_KEY: str = "SigningKeyToChange__NOT_SUITABLE_FOR_PRODUCTION" # Sentry SENTRY_DSN: Optional[str] = None