plash-cli 0.3.13__tar.gz → 0.3.15__tar.gz

{plash_cli-0.3.13/plash_cli.egg-info → plash_cli-0.3.15}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: plash_cli
-Version: 0.3.13
+Version: 0.3.15
 Summary: CLI for the Plash hosting service
 Author-email: Jeremy Howard <info@fast.ai>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Repository, https://github.com/AnswerDotAI/plash_cli
 Project-URL: Documentation, https://AnswerDotAI.github.io/plash_cli
 Keywords: nbdev,jupyter,notebook,python
@@ -15,8 +15,8 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore
-Requires-Dist: httpx>=0.28.1
+Requires-Dist: fastcore>=2.2.20
+Requires-Dist: httpx2
 Requires-Dist: python-dotenv
 Requires-Dist: pyjwt
 Requires-Dist: cryptography
@@ -32,34 +32,24 @@ Dynamic: license-file
 
 > [!WARNING]
 >
-> Plash is in Beta and we have released it in its semi-stable state to
-> gather early feedback to improve. We do not recommend hosting critical
-> applications yet.
+> Plash is in Beta and we have released it in its semi-stable state to gather early feedback to improve. We do not recommend hosting critical applications yet.
 
 ## What is Plash
 
-Plash is a next-generation deployment platform for fast, hassle-free
-Python application hosting. It’s designed to be:
+Plash is a next-generation deployment platform for fast, hassle-free Python application hosting. It’s designed to be:
 
-- **Simple and streamlined** - deploy your applications with minimal
-  configuration
+- **Simple and streamlined** - deploy your applications with minimal configuration
 - **Developer-focused** - built for coders, not cloud engineers
 - **Fast and efficient** - get your app online in seconds, not days
 
-Plash handles all the deployment complexities so you can focus on what
-matters: building great applications. With Plash, you can deploy any
-Python app using straightforward commands and configurations, letting
-you ship your work quickly and reliably.
+Plash handles all the deployment complexities so you can focus on what matters: building great applications. With Plash, you can deploy any Python app using straightforward commands and configurations, letting you ship your work quickly and reliably.
 
-Whether you’re building web services, APIs, data applications, or tools,
-Plash provides the infrastructure backbone so you can concentrate on
-creating a splash with your code.
+Whether you’re building web services, APIs, data applications, or tools, Plash provides the infrastructure backbone so you can concentrate on creating a splash with your code.
 
 ## Tutorial: deploy your first app
 
-In this tutorial you will learn how to deploy your first app. This
-tutorial will explore the basics of using Plash and help you get
-familiar with it at a high level.
+In this tutorial you will learn how to deploy your first app.
+This tutorial will explore the basics of using Plash and help you get familiar with it at a high level.
 
 **Prerequisites:**
 
@@ -81,23 +71,29 @@ The CLI lets you manage your whole app’s lifecycle
 Authenticate with your Plash account:
 
 ``` sh
-plash_login
+plash-login
 ```
 
-This command opens your browser to authenticate with your Plash account.
-After completing the login process, you’ll see a “complete” confirmation
-page in your browser.
+This command opens your browser to authenticate with your Plash account. After completing the login process, you’ll see a “complete” confirmation page in your browser.
 
 Return to your terminal where you’ll find the confirmation message:
 
-> Authentication successful! Config saved to
-> <your-global-config-path>/plash_config.json
+> Authentication successful! Config saved to <your-global-config-path>/plash_config.json
+
+#### Alternative Authentication Methods
+
+If you’ve already logged in on one machine and want to authenticate on another without opening a browser, you can transfer your authentication token directly. Run `plash-login --show` on the machine where you’re already logged in to print your current token. You can then copy this and use `plash-login --token <your-token>` on the new machine to authenticate.
+
+For convenience, you can pipe the token directly to your clipboard. On macOS, use `plash-login --show | pbcopy`. On Linux with X11, use `plash-login --show | xclip -selection clipboard` or `plash-login --show | xsel --clipboard`. On Windows PowerShell, use `plash-login --show | Set-Clipboard`.
+
+For automated environments like CI/CD pipelines or scripts, you can set the `PLASH_TOKEN` environment variable instead of storing credentials in a config file. When this variable is set, the CLI will use it automatically without requiring `plash-login`. For example: `export PLASH_TOKEN="your-authentication-token"` on Unix-like systems, or `$env:PLASH_TOKEN="your-authentication-token"` in PowerShell.
 
 ### 3. Create your first app
 
 Create a new directory for your first app:
 
 ``` bash
+%%bash
 mkdir -p plash-tutorial
 cd plash-tutorial
 ```
@@ -105,6 +101,7 @@ cd plash-tutorial
 Next, create the `main.py` file:
 
 ``` python
+%%writefile main.py
 from fasthtml.common import *
 
 app, rt = fast_app()
@@ -116,24 +113,22 @@ def index():
 serve()
 ```
 
-This is a basic [FastHTML](https://fastht.ml) app. Plash also supports
-other popular python frameworks.
+This is a basic [FastHTML](https://fastht.ml) app. Plash also supports other popular python frameworks.
 
 > [!WARNING]
 >
-> Your app must use port 5001, as this is the port exposed by Plash’s
-> Docker container. It also happens to be the default for FastHTML apps.
+> Your app must use port 5001, as this is the port exposed by Plash’s Docker container. It also happens to be the default for FastHTML apps.
 
 And create the `requirements.txt` file:
 
 ``` python
+%%writefile requirements.txt
 python-fasthtml
 ```
 
 ### 4. Deploy your app
 
-Now that you’ve created your app files, you’re ready to deploy! From
-your `plash-tutorial` directory, run: `plash_deploy`
+Now that you’ve created your app files, you’re ready to deploy! From your `plash-tutorial` directory, run: `plash-deploy`
 
 This command will:
 
@@ -142,28 +137,27 @@ This command will:
 3.  Build and deploy your application
 
 ``` bash
-plash_deploy
+%%bash
+plash-deploy
 ```
 
     Initializing deployment...
     ✅ Upload complete! Your app is currently being built.
     It will be live at https://example-app.pla.sh
 
-**Note:** You’ll see a different url that has been randomly generated
-for your app.
+**Note:** You’ll see a different url that has been randomly generated for your app.
 
 ### 5. View your app
 
-Your app should be ready a couple of seconds after running the deploy
-command.
+Your app should be ready a couple of seconds after running the deploy command.
 
 Once your app is ready, you can:
 
 1.  Open the provided URL in your browser, or
-2.  Use the convenient plash_view command to open it automatically:
+2.  Use the convenient plash-view command to open it automatically:
 
 ``` sh
-plash_view
+plash-view
 ```
 
 When you visit that page you should see “Hello, World!”
@@ -172,21 +166,11 @@ When you visit that page you should see “Hello, World!”
 
 ## Where to go from here
 
-Learn more about what Plash has to offer in the rest of the docs at:
-<https://docs.pla.sh>
+Learn more about what Plash has to offer in the rest of the docs at: <https://docs.pla.sh>
 
-To learn more about creating web apps with FastHTML, we recommend
-looking at the official docs at: <https://fastht.ml/docs/>. In
-particular, we recommend the following:
+To learn more about creating web apps with FastHTML, we recommend looking at the official docs at: <https://fastht.ml/docs/>. In particular, we recommend the following:
 
-1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup
-    authentication for your Plash App with Google Sign-In or other OAuth
-    Providers.
-2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept
-    payments for your products hosted on Plash with Stripe.
+1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup authentication for your Plash App with Google Sign-In or other OAuth Providers.
+2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept payments for your products hosted on Plash with Stripe.
 
-Would you like to use a different python web framework? Then check out
-the [examples
-section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of
-the repo, it has examples for many popular python web frameworks like
-FastAPI, Gradio, and Streamlit.
+Would you like to use a different python web framework? Then check out the [examples section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of the repo, it has examples for many popular python web frameworks like FastAPI, Gradio, and Streamlit.

plash_cli-0.3.15/README.md

@@ -0,0 +1,149 @@
+# Plash
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+> [!WARNING]
+>
+> Plash is in Beta and we have released it in its semi-stable state to gather early feedback to improve. We do not recommend hosting critical applications yet.
+
+## What is Plash
+
+Plash is a next-generation deployment platform for fast, hassle-free Python application hosting. It’s designed to be:
+
+- **Simple and streamlined** - deploy your applications with minimal configuration
+- **Developer-focused** - built for coders, not cloud engineers
+- **Fast and efficient** - get your app online in seconds, not days
+
+Plash handles all the deployment complexities so you can focus on what matters: building great applications. With Plash, you can deploy any Python app using straightforward commands and configurations, letting you ship your work quickly and reliably.
+
+Whether you’re building web services, APIs, data applications, or tools, Plash provides the infrastructure backbone so you can concentrate on creating a splash with your code.
+
+## Tutorial: deploy your first app
+
+In this tutorial you will learn how to deploy your first app.
+This tutorial will explore the basics of using Plash and help you get familiar with it at a high level.
+
+**Prerequisites:**
+
+- A registered account at <https://pla.sh>
+- Basic terminal / command line skills
+
+### 1. Installation
+
+Install Plash comandline interface (CLI) with pip:
+
+``` sh
+pip install plash-cli
+```
+
+The CLI lets you manage your whole app’s lifecycle
+
+### 2. CLI Login
+
+Authenticate with your Plash account:
+
+``` sh
+plash-login
+```
+
+This command opens your browser to authenticate with your Plash account. After completing the login process, you’ll see a “complete” confirmation page in your browser.
+
+Return to your terminal where you’ll find the confirmation message:
+
+> Authentication successful! Config saved to <your-global-config-path>/plash_config.json
+
+#### Alternative Authentication Methods
+
+If you’ve already logged in on one machine and want to authenticate on another without opening a browser, you can transfer your authentication token directly. Run `plash-login --show` on the machine where you’re already logged in to print your current token. You can then copy this and use `plash-login --token <your-token>` on the new machine to authenticate.
+
+For convenience, you can pipe the token directly to your clipboard. On macOS, use `plash-login --show | pbcopy`. On Linux with X11, use `plash-login --show | xclip -selection clipboard` or `plash-login --show | xsel --clipboard`. On Windows PowerShell, use `plash-login --show | Set-Clipboard`.
+
+For automated environments like CI/CD pipelines or scripts, you can set the `PLASH_TOKEN` environment variable instead of storing credentials in a config file. When this variable is set, the CLI will use it automatically without requiring `plash-login`. For example: `export PLASH_TOKEN="your-authentication-token"` on Unix-like systems, or `$env:PLASH_TOKEN="your-authentication-token"` in PowerShell.
+
+### 3. Create your first app
+
+Create a new directory for your first app:
+
+``` bash
+%%bash
+mkdir -p plash-tutorial
+cd plash-tutorial
+```
+
+Next, create the `main.py` file:
+
+``` python
+%%writefile main.py
+from fasthtml.common import *
+
+app, rt = fast_app()
+
+@rt
+def index():
+    return H1("Hello, world!")
+
+serve()
+```
+
+This is a basic [FastHTML](https://fastht.ml) app. Plash also supports other popular python frameworks.
+
+> [!WARNING]
+>
+> Your app must use port 5001, as this is the port exposed by Plash’s Docker container. It also happens to be the default for FastHTML apps.
+
+And create the `requirements.txt` file:
+
+``` python
+%%writefile requirements.txt
+python-fasthtml
+```
+
+### 4. Deploy your app
+
+Now that you’ve created your app files, you’re ready to deploy! From your `plash-tutorial` directory, run: `plash-deploy`
+
+This command will:
+
+1.  Package your application files
+2.  Upload them to Plash’s servers
+3.  Build and deploy your application
+
+``` bash
+%%bash
+plash-deploy
+```
+
+    Initializing deployment...
+    ✅ Upload complete! Your app is currently being built.
+    It will be live at https://example-app.pla.sh
+
+**Note:** You’ll see a different url that has been randomly generated for your app.
+
+### 5. View your app
+
+Your app should be ready a couple of seconds after running the deploy command.
+
+Once your app is ready, you can:
+
+1.  Open the provided URL in your browser, or
+2.  Use the convenient plash-view command to open it automatically:
+
+``` sh
+plash-view
+```
+
+When you visit that page you should see “Hello, World!”
+
+🎉 Congratulations! You deployed your first app on Plash!
+
+## Where to go from here
+
+Learn more about what Plash has to offer in the rest of the docs at: <https://docs.pla.sh>
+
+To learn more about creating web apps with FastHTML, we recommend looking at the official docs at: <https://fastht.ml/docs/>. In particular, we recommend the following:
+
+1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup authentication for your Plash App with Google Sign-In or other OAuth Providers.
+2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept payments for your products hosted on Plash with Stripe.
+
+Would you like to use a different python web framework? Then check out the [examples section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of the repo, it has examples for many popular python web frameworks like FastAPI, Gradio, and Streamlit.

plash_cli-0.3.15/plash_cli/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.3.15"
+from .cli import *

{plash_cli-0.3.13 → plash_cli-0.3.15}/plash_cli/auth.py

@@ -1,4 +1,6 @@
-"""Client side logic to add Plash Auth to your app"""
+"""Client side logic to add Plash Auth to your app
+
+Docs: https://AnswerDotAI.github.io/plash_cli/auth.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_auth.ipynb.
 
@@ -27,9 +29,11 @@ def _signin_url(email_re: str=None, hd_re: str=None):
 signin_completed_rt = "/signin_completed"
 
 # %% ../nbs/01_auth.ipynb #74a0a24d
-def mk_signin_url(session: dict,       # Session dictionary
-                        email_re: str=None,  # Regex filter for allowed email addresses
-                        hd_re: str=None):    # Regex filter for allowed Google hosted domains
+def mk_signin_url(
+    session: dict,       # Session dictionary
+    email_re: str=None,  # Regex filter for allowed email addresses
+    hd_re: str=None # Regex filter for allowed Google hosted domains
+):
     "Generate a Google Sign-In URL for Plash authentication."
     if not _in_prod: return f"{signin_completed_rt}?signin_reply=mock-sign-in-reply"
     res = _signin_url(email_re, hd_re)
@@ -50,8 +54,10 @@ class PlashAuthError(Exception):
     pass
 
 # %% ../nbs/01_auth.ipynb #a311ce9a
-def goog_id_from_signin_reply(session: dict, # Session dictionary containing 'req_id'
-                              reply: str):   # The JWT reply string from Plash after Google authentication
+def goog_id_from_signin_reply(
+    session: dict, # Session dictionary containing 'req_id'
+    reply: str # The JWT reply string from Plash after Google authentication
+):
     "Validate Google sign-in reply and returns Google user ID if valid."
     if not _in_prod: return '424242424242424242424'
     parsed = _parse_jwt(reply)

{plash_cli-0.3.13 → plash_cli-0.3.15}/plash_cli/cli.py

@@ -1,4 +1,6 @@
-"""The Plash CLI tool"""
+"""The Plash CLI tool
+
+Docs: https://AnswerDotAI.github.io/plash_cli/cli.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_cli.ipynb.
 
@@ -9,7 +11,7 @@ __all__ = ['PLASH_CONFIG_HOME', 'PLASH_DOMAIN', 'pat', 'log_modes', 'PlashError'
 # %% ../nbs/00_cli.ipynb #702c219c
 from fastcore.all import *
 from fastcore.xdg import *
-import secrets, webbrowser, httpx, io, tarfile, random, string
+import secrets, webbrowser, httpx2, io, tarfile, random, string
 from pathlib import Path
 from uuid import uuid4
 from time import time, sleep
@@ -23,10 +25,10 @@ PLASH_DOMAIN = os.getenv("PLASH_DOMAIN","pla.sh")  # pla.sh plash-dev.answer.ai
 
 # %% ../nbs/00_cli.ipynb #1de1e2b3
 def _get_client(cfg=PLASH_CONFIG_HOME):
-    client = httpx.Client()
+    client = httpx2.Client()
     if tok := os.getenv("PLASH_TOKEN"): cookies = {"session_": tok}
     elif cfg.exists(): cookies = cfg.read_json()
-    else: raise FileNotFoundError("Config not found. Run plash_login and retry.")
+    else: raise FileNotFoundError("Config not found. Run plash-login and retry.")
     client.cookies.update(cookies)
     client.headers.update({'X-PLASH': 'true', 'User-Agent': f'plash_cli/{__version__}'})
     return client
@@ -75,7 +77,7 @@ class PlashError(Exception): pass
 def _poll_cookies(paircode, interval=1, timeout=180):
     "Poll server for token until received or timeout"
     start = time()
-    client = httpx.Client()
+    client = httpx2.Client()
     url = _endpoint(rt=f"/cli_token?paircode={paircode}")
     while time()-start < timeout:
         resp = client.get(url).raise_for_status()
@@ -96,7 +98,7 @@ def login(
         PLASH_CONFIG_HOME.write_json({"session_": token.strip()})
         return f"Token saved to {PLASH_CONFIG_HOME}"
     paircode = secrets.token_urlsafe(16)
-    login_url = httpx.get(_endpoint(rt=f"/cli_login?paircode={paircode}")).text
+    login_url = httpx2.get(_endpoint(rt=f"/cli_login?paircode={paircode}")).text
     print(f"Opening browser for authentication:\n{login_url}\n")
     webbrowser.open(login_url)
     
@@ -150,7 +152,8 @@ def create_tar_archive(path:Path, force_data:bool=False) -> tuple[io.BytesIO, in
 def deploy(
     path:Path='.',    # Path to project
     name:str=None,          # Overrides the .plash file in project root if provided
-    _force_data:bool=False): # Overwrite data/ directory during deployment
+    _force_data:bool=False # Overwrite data/ directory during deployment
+):
     """
     Deploys app to production. By default, this command erases all files in your app which are not in data/.
     Then uploads all files and folders, except paths starting with `.` and except the local data/ directory.
@@ -178,10 +181,11 @@ def deploy(
 def _deploy(
     path:Path='.',    # Path to project
     name:str=None,          # Overrides the .plash file in project root if provided
-    force_data:bool=False): # Overwrite data/ directory during deployment
+    force_data:bool=False # Overwrite data/ directory during deployment
+):
     print('Initializing deployment...')
     try: res = deploy(path=path, name=name, _force_data=force_data)
-    except PlashError as e: return str(e)
+    except PlashError as e: raise CliError(str(e))
     print('✅ Upload complete! Your app is currently being built.\n' +
         f'It will be live at {res}')
 _deploy.__doc__ = deploy.__doc__
@@ -201,7 +205,8 @@ def view(
 # %% ../nbs/00_cli.ipynb #43535aef
 def delete_app(
     path:Path='.', # Path to project
-    name:str=None):      # Overrides the .plash file in project root if provided
+    name:str=None # Overrides the .plash file in project root if provided
+):
     'Delete your deployed app'
     name = _prep(path, name)
     _mk_auth_req(_endpoint(rt=f"/delete?name={name}"), "delete")
@@ -209,20 +214,23 @@ def delete_app(
 
 @call_parse
 @delegates(delete_app)
-def _delete(force:bool=False,  # Skip confirmation prompt
-    **kwargs):
+def _delete(
+    force:bool=False,  # Skip confirmation prompt
+    **kwargs
+):
     'Delete your deployed app'
     if not force:
         confirm = input("Are you sure you want to delete the app? [y/N]: ")
         if confirm.lower() not in ['y', 'yes']: return print("Deletion cancelled.")
     try: print(delete_app(**kwargs))
-    except PlashError as e:  return str(e)
+    except PlashError as e:  raise CliError(str(e))
 _delete.__doc__ = delete_app.__doc__
 
 # %% ../nbs/00_cli.ipynb #d72ccd37
 def start_app(
     path:Path='.', # Path to project
-    name:str=None):      # Overrides the .plash file in project root if provided
+    name:str=None # Overrides the .plash file in project root if provided
+):
     'Start your deployed app'
     name = _prep(path, name)
     _mk_auth_req(_endpoint(rt=f"/start?name={name}"))
@@ -232,13 +240,14 @@ def start_app(
 @delegates(start_app)
 def _start(**kwargs):
     try: print(start_app(**kwargs))
-    except PlashError as e:  return str(e)
+    except PlashError as e:  raise CliError(str(e))
 _start.__doc__ = start_app.__doc__
 
 # %% ../nbs/00_cli.ipynb #ace91510
 def stop_app(
     path:Path='.', # Path to project
-    name:str=None):      # Overrides the .plash file in project root if provided
+    name:str=None # Overrides the .plash file in project root if provided
+):
     'Stop your deployed app'
     name = _prep(path, name)
     _mk_auth_req(_endpoint(rt=f"/stop?name={name}"))
@@ -248,7 +257,7 @@ def stop_app(
 @delegates(stop_app)
 def _stop(**kwargs):
     try: print(stop_app(**kwargs))
-    except PlashError as e:  return str(e)
+    except PlashError as e:  raise CliError(str(e))
 _stop.__doc__ = stop_app.__doc__
 
 # %% ../nbs/00_cli.ipynb #24e62f1f
@@ -258,7 +267,8 @@ log_modes = str_enum('log_modes', 'build', 'app')
 def logs(
     path:Path='.',    # Path to project
     name:str=None,          # Overrides the .plash file in project root if provided
-    mode:log_modes='build'): # Choose between build or app logs
+    mode:log_modes='build' # Choose between build or app logs
+):
     'Get logs for your deployed app'
     name = _prep(path, name)
     r = _mk_auth_req(_endpoint(rt=f"/logs?name={name}&mode={mode}"))
@@ -266,8 +276,10 @@ def logs(
 
 @call_parse
 @delegates(logs)
-def _logs(tail:bool=False,  # Tail the logs
-    **kwargs):
+def _logs(
+    tail:bool=False,  # Tail the logs
+    **kwargs
+):
     try:
         if not tail: return print(logs(**kwargs))
         text = ''
@@ -279,7 +291,7 @@ def _logs(tail:bool=False,  # Tail the logs
                 if kwargs.get('mode','build') == 'build' and 'Build End Time:' in new_text: return
                 sleep(1)
             except KeyboardInterrupt: print("\nExiting"); return
-    except PlashError as e:  return str(e)
+    except PlashError as e: raise CliError(str(e))
 _logs.__doc__ = logs.__doc__
 
 # %% ../nbs/00_cli.ipynb #f8441125
@@ -290,7 +302,8 @@ def _is_dir_empty(self:Path): return next(self.iterdir(), None) is None
 def download_app(
     path:Path='.',  # Path to project
     name:str=None,        # Overrides the .plash file in project root if provided
-    save_path:Path="./download/"): # Save path (optional)
+    save_path:Path="./download/" # Save path (optional)
+):
     "Download deployed app to save_path."
     name = _prep(path, name)
     save_path = Path(save_path)
@@ -305,7 +318,7 @@ def download_app(
 @delegates(download_app)
 def _download(**kwargs):
     try: print(f"Downloaded your app to: {download_app(**kwargs)}")
-    except PlashError as e:  return str(e)
+    except PlashError as e:  raise CliError(str(e))
 _download.__doc__ = download_app.__doc__
 
 # %% ../nbs/00_cli.ipynb #8378e31d
@@ -317,7 +330,7 @@ def app_list():
 @call_parse
 def _app_list(verbose:bool=False): # Whether to show running status as well as name: 1=running, 0=stopped
     try: res = app_list()
-    except PlashError as e: return str(e)
+    except PlashError as e: raise CliError(str(e))
     if not res: print("You don't have any deployed Plash apps.")
     for a in res: print(f"{a['running']} {a['name']}" if verbose else a['name'])
 _app_list.__doc__ = app_list.__doc__

{plash_cli-0.3.13 → plash_cli-0.3.15/plash_cli.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: plash_cli
-Version: 0.3.13
+Version: 0.3.15
 Summary: CLI for the Plash hosting service
 Author-email: Jeremy Howard <info@fast.ai>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Repository, https://github.com/AnswerDotAI/plash_cli
 Project-URL: Documentation, https://AnswerDotAI.github.io/plash_cli
 Keywords: nbdev,jupyter,notebook,python
@@ -15,8 +15,8 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore
-Requires-Dist: httpx>=0.28.1
+Requires-Dist: fastcore>=2.2.20
+Requires-Dist: httpx2
 Requires-Dist: python-dotenv
 Requires-Dist: pyjwt
 Requires-Dist: cryptography
@@ -32,34 +32,24 @@ Dynamic: license-file
 
 > [!WARNING]
 >
-> Plash is in Beta and we have released it in its semi-stable state to
-> gather early feedback to improve. We do not recommend hosting critical
-> applications yet.
+> Plash is in Beta and we have released it in its semi-stable state to gather early feedback to improve. We do not recommend hosting critical applications yet.
 
 ## What is Plash
 
-Plash is a next-generation deployment platform for fast, hassle-free
-Python application hosting. It’s designed to be:
+Plash is a next-generation deployment platform for fast, hassle-free Python application hosting. It’s designed to be:
 
-- **Simple and streamlined** - deploy your applications with minimal
-  configuration
+- **Simple and streamlined** - deploy your applications with minimal configuration
 - **Developer-focused** - built for coders, not cloud engineers
 - **Fast and efficient** - get your app online in seconds, not days
 
-Plash handles all the deployment complexities so you can focus on what
-matters: building great applications. With Plash, you can deploy any
-Python app using straightforward commands and configurations, letting
-you ship your work quickly and reliably.
+Plash handles all the deployment complexities so you can focus on what matters: building great applications. With Plash, you can deploy any Python app using straightforward commands and configurations, letting you ship your work quickly and reliably.
 
-Whether you’re building web services, APIs, data applications, or tools,
-Plash provides the infrastructure backbone so you can concentrate on
-creating a splash with your code.
+Whether you’re building web services, APIs, data applications, or tools, Plash provides the infrastructure backbone so you can concentrate on creating a splash with your code.
 
 ## Tutorial: deploy your first app
 
-In this tutorial you will learn how to deploy your first app. This
-tutorial will explore the basics of using Plash and help you get
-familiar with it at a high level.
+In this tutorial you will learn how to deploy your first app.
+This tutorial will explore the basics of using Plash and help you get familiar with it at a high level.
 
 **Prerequisites:**
 
@@ -81,23 +71,29 @@ The CLI lets you manage your whole app’s lifecycle
 Authenticate with your Plash account:
 
 ``` sh
-plash_login
+plash-login
 ```
 
-This command opens your browser to authenticate with your Plash account.
-After completing the login process, you’ll see a “complete” confirmation
-page in your browser.
+This command opens your browser to authenticate with your Plash account. After completing the login process, you’ll see a “complete” confirmation page in your browser.
 
 Return to your terminal where you’ll find the confirmation message:
 
-> Authentication successful! Config saved to
-> <your-global-config-path>/plash_config.json
+> Authentication successful! Config saved to <your-global-config-path>/plash_config.json
+
+#### Alternative Authentication Methods
+
+If you’ve already logged in on one machine and want to authenticate on another without opening a browser, you can transfer your authentication token directly. Run `plash-login --show` on the machine where you’re already logged in to print your current token. You can then copy this and use `plash-login --token <your-token>` on the new machine to authenticate.
+
+For convenience, you can pipe the token directly to your clipboard. On macOS, use `plash-login --show | pbcopy`. On Linux with X11, use `plash-login --show | xclip -selection clipboard` or `plash-login --show | xsel --clipboard`. On Windows PowerShell, use `plash-login --show | Set-Clipboard`.
+
+For automated environments like CI/CD pipelines or scripts, you can set the `PLASH_TOKEN` environment variable instead of storing credentials in a config file. When this variable is set, the CLI will use it automatically without requiring `plash-login`. For example: `export PLASH_TOKEN="your-authentication-token"` on Unix-like systems, or `$env:PLASH_TOKEN="your-authentication-token"` in PowerShell.
 
 ### 3. Create your first app
 
 Create a new directory for your first app:
 
 ``` bash
+%%bash
 mkdir -p plash-tutorial
 cd plash-tutorial
 ```
@@ -105,6 +101,7 @@ cd plash-tutorial
 Next, create the `main.py` file:
 
 ``` python
+%%writefile main.py
 from fasthtml.common import *
 
 app, rt = fast_app()
@@ -116,24 +113,22 @@ def index():
 serve()
 ```
 
-This is a basic [FastHTML](https://fastht.ml) app. Plash also supports
-other popular python frameworks.
+This is a basic [FastHTML](https://fastht.ml) app. Plash also supports other popular python frameworks.
 
 > [!WARNING]
 >
-> Your app must use port 5001, as this is the port exposed by Plash’s
-> Docker container. It also happens to be the default for FastHTML apps.
+> Your app must use port 5001, as this is the port exposed by Plash’s Docker container. It also happens to be the default for FastHTML apps.
 
 And create the `requirements.txt` file:
 
 ``` python
+%%writefile requirements.txt
 python-fasthtml
 ```
 
 ### 4. Deploy your app
 
-Now that you’ve created your app files, you’re ready to deploy! From
-your `plash-tutorial` directory, run: `plash_deploy`
+Now that you’ve created your app files, you’re ready to deploy! From your `plash-tutorial` directory, run: `plash-deploy`
 
 This command will:
 
@@ -142,28 +137,27 @@ This command will:
 3.  Build and deploy your application
 
 ``` bash
-plash_deploy
+%%bash
+plash-deploy
 ```
 
     Initializing deployment...
     ✅ Upload complete! Your app is currently being built.
     It will be live at https://example-app.pla.sh
 
-**Note:** You’ll see a different url that has been randomly generated
-for your app.
+**Note:** You’ll see a different url that has been randomly generated for your app.
 
 ### 5. View your app
 
-Your app should be ready a couple of seconds after running the deploy
-command.
+Your app should be ready a couple of seconds after running the deploy command.
 
 Once your app is ready, you can:
 
 1.  Open the provided URL in your browser, or
-2.  Use the convenient plash_view command to open it automatically:
+2.  Use the convenient plash-view command to open it automatically:
 
 ``` sh
-plash_view
+plash-view
 ```
 
 When you visit that page you should see “Hello, World!”
@@ -172,21 +166,11 @@ When you visit that page you should see “Hello, World!”
 
 ## Where to go from here
 
-Learn more about what Plash has to offer in the rest of the docs at:
-<https://docs.pla.sh>
+Learn more about what Plash has to offer in the rest of the docs at: <https://docs.pla.sh>
 
-To learn more about creating web apps with FastHTML, we recommend
-looking at the official docs at: <https://fastht.ml/docs/>. In
-particular, we recommend the following:
+To learn more about creating web apps with FastHTML, we recommend looking at the official docs at: <https://fastht.ml/docs/>. In particular, we recommend the following:
 
-1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup
-    authentication for your Plash App with Google Sign-In or other OAuth
-    Providers.
-2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept
-    payments for your products hosted on Plash with Stripe.
+1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup authentication for your Plash App with Google Sign-In or other OAuth Providers.
+2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept payments for your products hosted on Plash with Stripe.
 
-Would you like to use a different python web framework? Then check out
-the [examples
-section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of
-the repo, it has examples for many popular python web frameworks like
-FastAPI, Gradio, and Streamlit.
+Would you like to use a different python web framework? Then check out the [examples section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of the repo, it has examples for many popular python web frameworks like FastAPI, Gradio, and Streamlit.

plash_cli-0.3.15/plash_cli.egg-info/entry_points.txt

@@ -0,0 +1,13 @@
+[console_scripts]
+plash-apps = plash_cli.cli:_app_list
+plash-delete = plash_cli.cli:_delete
+plash-deploy = plash_cli.cli:_deploy
+plash-download = plash_cli.cli:_download
+plash-login = plash_cli.cli:login
+plash-logs = plash_cli.cli:_logs
+plash-start = plash_cli.cli:_start
+plash-stop = plash_cli.cli:_stop
+plash-view = plash_cli.cli:view
+
+[nbdev]
+plash_cli = plash_cli._modidx:d

{plash_cli-0.3.13 → plash_cli-0.3.15}/plash_cli.egg-info/requires.txt

@@ -1,5 +1,5 @@
-fastcore
-httpx>=0.28.1
+fastcore>=2.2.20
+httpx2
 python-dotenv
 pyjwt
 cryptography

{plash_cli-0.3.13 → plash_cli-0.3.15}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=64"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -8,11 +8,11 @@ dynamic = ["version"]
 description = "CLI for the Plash hosting service"
 readme = "README.md"
 requires-python = ">=3.10"
-license = {text = "Apache-2.0"}
+license = "Apache-2.0"
 authors = [{name = "Jeremy Howard", email = "info@fast.ai"}]
 keywords = ['nbdev', 'jupyter', 'notebook', 'python']
 classifiers = ["Natural Language :: English", "Intended Audience :: Developers", "Development Status :: 3 - Alpha", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only"]
-dependencies = ['fastcore', 'httpx>=0.28.1', 'python-dotenv', 'pyjwt', 'cryptography']
+dependencies = ['fastcore>=2.2.20', 'httpx2', 'python-dotenv', 'pyjwt', 'cryptography']
 
 [project.urls]
 Repository = "https://github.com/AnswerDotAI/plash_cli"
@@ -26,15 +26,15 @@ dev = ['bash_kernel', 'nbdev>=3']
 
 
 [project.scripts]
-plash_deploy = "plash_cli.cli:_deploy"
-plash_login = "plash_cli.cli:login"
-plash_view = "plash_cli.cli:view"
-plash_logs = "plash_cli.cli:_logs"
-plash_delete = "plash_cli.cli:_delete"
-plash_stop = "plash_cli.cli:_stop"
-plash_start = "plash_cli.cli:_start"
-plash_download = "plash_cli.cli:_download"
-plash_apps = "plash_cli.cli:_app_list"
+plash-deploy = "plash_cli.cli:_deploy"
+plash-login = "plash_cli.cli:login"
+plash-view = "plash_cli.cli:view"
+plash-logs = "plash_cli.cli:_logs"
+plash-delete = "plash_cli.cli:_delete"
+plash-stop = "plash_cli.cli:_stop"
+plash-start = "plash_cli.cli:_start"
+plash-download = "plash_cli.cli:_download"
+plash-apps = "plash_cli.cli:_app_list"
 
 [tool.setuptools.dynamic]
 version = {attr = "plash_cli.__version__"}
@@ -43,4 +43,9 @@ version = {attr = "plash_cli.__version__"}
 include = ["plash_cli"]
 
 [tool.nbdev]
+allowed_metadata_keys = ['solveit']
+allowed_cell_metadata_keys = ['solveit_ai']
 custom_sidebar = false
+
+[tool.chkstyle]
+skip_paths = ["_modidx.py"]

plash_cli-0.3.13/README.md

@@ -1,165 +0,0 @@
-# Plash
-
-
-<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
-
-> [!WARNING]
->
-> Plash is in Beta and we have released it in its semi-stable state to
-> gather early feedback to improve. We do not recommend hosting critical
-> applications yet.
-
-## What is Plash
-
-Plash is a next-generation deployment platform for fast, hassle-free
-Python application hosting. It’s designed to be:
-
-- **Simple and streamlined** - deploy your applications with minimal
-  configuration
-- **Developer-focused** - built for coders, not cloud engineers
-- **Fast and efficient** - get your app online in seconds, not days
-
-Plash handles all the deployment complexities so you can focus on what
-matters: building great applications. With Plash, you can deploy any
-Python app using straightforward commands and configurations, letting
-you ship your work quickly and reliably.
-
-Whether you’re building web services, APIs, data applications, or tools,
-Plash provides the infrastructure backbone so you can concentrate on
-creating a splash with your code.
-
-## Tutorial: deploy your first app
-
-In this tutorial you will learn how to deploy your first app. This
-tutorial will explore the basics of using Plash and help you get
-familiar with it at a high level.
-
-**Prerequisites:**
-
-- A registered account at <https://pla.sh>
-- Basic terminal / command line skills
-
-### 1. Installation
-
-Install Plash comandline interface (CLI) with pip:
-
-``` sh
-pip install plash-cli
-```
-
-The CLI lets you manage your whole app’s lifecycle
-
-### 2. CLI Login
-
-Authenticate with your Plash account:
-
-``` sh
-plash_login
-```
-
-This command opens your browser to authenticate with your Plash account.
-After completing the login process, you’ll see a “complete” confirmation
-page in your browser.
-
-Return to your terminal where you’ll find the confirmation message:
-
-> Authentication successful! Config saved to
-> <your-global-config-path>/plash_config.json
-
-### 3. Create your first app
-
-Create a new directory for your first app:
-
-``` bash
-mkdir -p plash-tutorial
-cd plash-tutorial
-```
-
-Next, create the `main.py` file:
-
-``` python
-from fasthtml.common import *
-
-app, rt = fast_app()
-
-@rt
-def index():
-    return H1("Hello, world!")
-
-serve()
-```
-
-This is a basic [FastHTML](https://fastht.ml) app. Plash also supports
-other popular python frameworks.
-
-> [!WARNING]
->
-> Your app must use port 5001, as this is the port exposed by Plash’s
-> Docker container. It also happens to be the default for FastHTML apps.
-
-And create the `requirements.txt` file:
-
-``` python
-python-fasthtml
-```
-
-### 4. Deploy your app
-
-Now that you’ve created your app files, you’re ready to deploy! From
-your `plash-tutorial` directory, run: `plash_deploy`
-
-This command will:
-
-1.  Package your application files
-2.  Upload them to Plash’s servers
-3.  Build and deploy your application
-
-``` bash
-plash_deploy
-```
-
-    Initializing deployment...
-    ✅ Upload complete! Your app is currently being built.
-    It will be live at https://example-app.pla.sh
-
-**Note:** You’ll see a different url that has been randomly generated
-for your app.
-
-### 5. View your app
-
-Your app should be ready a couple of seconds after running the deploy
-command.
-
-Once your app is ready, you can:
-
-1.  Open the provided URL in your browser, or
-2.  Use the convenient plash_view command to open it automatically:
-
-``` sh
-plash_view
-```
-
-When you visit that page you should see “Hello, World!”
-
-🎉 Congratulations! You deployed your first app on Plash!
-
-## Where to go from here
-
-Learn more about what Plash has to offer in the rest of the docs at:
-<https://docs.pla.sh>
-
-To learn more about creating web apps with FastHTML, we recommend
-looking at the official docs at: <https://fastht.ml/docs/>. In
-particular, we recommend the following:
-
-1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup
-    authentication for your Plash App with Google Sign-In or other OAuth
-    Providers.
-2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept
-    payments for your products hosted on Plash with Stripe.
-
-Would you like to use a different python web framework? Then check out
-the [examples
-section](https://github.com/AnswerDotAI/plash_cli/tree/main/examples) of
-the repo, it has examples for many popular python web frameworks like
-FastAPI, Gradio, and Streamlit.

plash_cli-0.3.13/plash_cli/__init__.py

@@ -1,2 +0,0 @@
-__version__ = "0.3.13"
-from .cli import *

plash_cli-0.3.13/plash_cli.egg-info/entry_points.txt

@@ -1,13 +0,0 @@
-[console_scripts]
-plash_apps = plash_cli.cli:_app_list
-plash_delete = plash_cli.cli:_delete
-plash_deploy = plash_cli.cli:_deploy
-plash_download = plash_cli.cli:_download
-plash_login = plash_cli.cli:login
-plash_logs = plash_cli.cli:_logs
-plash_start = plash_cli.cli:_start
-plash_stop = plash_cli.cli:_stop
-plash_view = plash_cli.cli:view
-
-[nbdev]
-plash_cli = plash_cli._modidx:d