Skip to content

fix deploy cmd docstring to clarify exclusions of dot files #27

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

Merged
merged 1 commit into from
Jun 2, 2025
Merged

fix deploy cmd docstring to clarify exclusions of dot files #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion nbs/00_core.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@
"def deploy(\n",
" path:Path=Path('.'), # Path to project\n",
" app_id:str=None): # Overrides the .plash file in project root if provided\n",
" 'Ship your app to production'\n",
" \"Deploy app to production (ignores paths starting with '.')\"\n",
" print('Initializing deployment...')\n",
" if app_id == '': print('Error: App ID cannot be an empty string'); return\n",
" if not path.is_dir(): print(\"Error: Path should point to the project directory\"); return\n",
Expand Down
136 changes: 68 additions & 68 deletions nbs/reference/00_cli.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_login [-h]\n",
"\n",
"Authenticate CLI with server and save config\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
"usage: plash_login [-h]\r\n",
"\r\n",
"Authenticate CLI with server and save config\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
"\n"
]
}
Expand Down Expand Up @@ -72,14 +72,14 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_deploy [-h] [--path PATH] [--app_id APP_ID]\n",
"\n",
"Ship your app to production\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
"usage: plash_deploy [-h] [--path PATH] [--app_id APP_ID]\r\n",
"\r\n",
"Deploy app to production (ignores paths starting with '.')\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
"\n"
]
}
Expand Down Expand Up @@ -107,14 +107,14 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_view [-h] [--path PATH] [--app_id APP_ID]\n",
"\n",
"Open your app in the browser\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project directory (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
"usage: plash_view [-h] [--path PATH] [--app_id APP_ID]\r\n",
"\r\n",
"Open your app in the browser\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project directory (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
"\n"
]
}
Expand Down Expand Up @@ -142,14 +142,14 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_start [-h] [--path PATH] [--app_id APP_ID]\n",
"\n",
"Access the '/start' endpoint for your app\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
"usage: plash_start [-h] [--path PATH] [--app_id APP_ID]\r\n",
"\r\n",
"Access the '/start' endpoint for your app\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
"\n"
]
}
Expand Down Expand Up @@ -177,14 +177,14 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_stop [-h] [--path PATH] [--app_id APP_ID]\n",
"\n",
"Access the '/stop' endpoint for your app\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
"usage: plash_stop [-h] [--path PATH] [--app_id APP_ID]\r\n",
"\r\n",
"Access the '/stop' endpoint for your app\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
"\n"
]
}
Expand Down Expand Up @@ -212,17 +212,17 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_logs [-h] [--path PATH] [--app_id APP_ID] [--mode {build,app}]\n",
" [--tail]\n",
"\n",
"Prints the logs for your deployed app\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
" --mode {build,app} Choose between build or app logs (default: build)\n",
" --tail Tail the logs (default: False)\n",
"usage: plash_logs [-h] [--path PATH] [--app_id APP_ID] [--mode {build,app}]\r\n",
" [--tail]\r\n",
"\r\n",
"Prints the logs for your deployed app\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
" --mode {build,app} Choose between build or app logs (default: build)\r\n",
" --tail Tail the logs (default: False)\r\n",
"\n"
]
}
Expand Down Expand Up @@ -250,16 +250,16 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_download [-h] [--path PATH] [--app_id APP_ID]\n",
" [--save_path SAVE_PATH]\n",
"\n",
"Download your deployed app\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
" --save_path SAVE_PATH Save path (optional) (default: download)\n",
"usage: plash_download [-h] [--path PATH] [--app_id APP_ID]\r\n",
" [--save_path SAVE_PATH]\r\n",
"\r\n",
"Download your deployed app\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
" --save_path SAVE_PATH Save path (optional) (default: download)\r\n",
"\n"
]
}
Expand Down Expand Up @@ -287,15 +287,15 @@
"name": "stdout",
"output_type": "stream",
"text": [
"usage: plash_delete [-h] [--path PATH] [--app_id APP_ID] [--force]\n",
"\n",
"Delete your deployed app\n",
"\n",
"options:\n",
" -h, --help show this help message and exit\n",
" --path PATH Path to project (default: .)\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\n",
" --force Skip confirmation prompt (default: False)\n",
"usage: plash_delete [-h] [--path PATH] [--app_id APP_ID] [--force]\r\n",
"\r\n",
"Delete your deployed app\r\n",
"\r\n",
"options:\r\n",
" -h, --help show this help message and exit\r\n",
" --path PATH Path to project (default: .)\r\n",
" --app_id APP_ID Overrides the .plash file in project root if provided\r\n",
" --force Skip confirmation prompt (default: False)\r\n",
"\n"
]
}
Expand Down
2 changes: 1 addition & 1 deletion plash_cli/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def create_tar_archive(path:Path) -> tuple[io.BytesIO, int]:
def deploy(
path:Path=Path('.'), # Path to project
app_id:str=None): # Overrides the .plash file in project root if provided
'Ship your app to production'
"Deploy app to production (ignores paths starting with '.')"
print('Initializing deployment...')
if app_id == '': print('Error: App ID cannot be an empty string'); return
if not path.is_dir(): print("Error: Path should point to the project directory"); return
Expand Down
Loading