Skip to content

📝(api) add CLI documentation #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmaupetit wants to merge 4 commits into
base: main
Choose a base branch
from
Open

📝(api) add CLI documentation #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b43488f
📝(api) add CLI documentation
jmaupetit Jan 31, 2024
d81ff6a
fixup! 📝(api) add CLI documentation
wilbrdt Jul 29, 2024
e4f79ad
🔧(project) add defaults to lrs settings
wilbrdt Jul 29, 2024
e601f86
fixup! 📝(api) add CLI documentation
wilbrdt Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Commands

<!-- prettier-ignore -->
::: mkdocs-click
:module: warren.cli
:command: cli
:depth: 1
2 changes: 2 additions & 0 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ theme:
markdown_extensions:
- admonition
- attr_list
- mkdocs_click
- smarty
- toc:
permalink: True
Expand All @@ -71,6 +72,7 @@ markdown_extensions:

nav:
- "Warren": index.md
- "CLI": cli.md
- "Plugins": plugins.md
- "Warren-TdBP": tdbp.md
- "Contributing": contribute.md
Expand Down
10 changes: 5 additions & 5 deletions src/api/core/warren/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down