plash-cli


Nameplash-cli JSON
Version 0.2.2 PyPI version JSON
download
home_pagehttps://github.com/AnswerDotAI/plash_cli
SummaryCLI for the Plash hosting service
upload_time2025-07-24 19:10:43
maintainerNone
docs_urlNone
authorJeremy Howard
requires_python>=3.11
licenseApache Software License 2.0
keywords nbdev jupyter notebook python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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>

For learning more about creating web apps with FastHTML, we recommend
looking at the official docs at: <https://fastht.ml/docs/>.

Particularly, 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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AnswerDotAI/plash_cli",
    "name": "plash-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "nbdev jupyter notebook python",
    "author": "Jeremy Howard",
    "author_email": "info@fast.ai",
    "download_url": "https://files.pythonhosted.org/packages/a9/00/47add504fe3d438cab1ea8124ac90222e3a1ca94b06e264dc0e5a50cad6f/plash_cli-0.2.2.tar.gz",
    "platform": null,
    "description": "# Plash\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n> [!WARNING]\n>\n> Plash is in Beta and we have released it in its semi-stable state to\n> gather early feedback to improve. We do not recommend hosting critical\n> applications yet.\n\n## What is Plash\n\nPlash is a next-generation deployment platform for fast, hassle-free\nPython application hosting. It\u2019s designed to be:\n\n- **Simple and streamlined** - deploy your applications with minimal\n  configuration\n- **Developer-focused** - built for coders, not cloud engineers\n- **Fast and efficient** - get your app online in seconds, not days\n\nPlash handles all the deployment complexities so you can focus on what\nmatters: building great applications. With Plash, you can deploy any\nPython app using straightforward commands and configurations, letting\nyou ship your work quickly and reliably.\n\nWhether you\u2019re building web services, APIs, data applications, or tools,\nPlash provides the infrastructure backbone so you can concentrate on\ncreating a splash with your code.\n\n## Tutorial: deploy your first app\n\nIn this tutorial you will learn how to deploy your first app. This\ntutorial will explore the basics of using Plash and help you get\nfamiliar with it at a high level.\n\n**Prerequisites:**\n\n- A registered account at <https://pla.sh>\n- Basic terminal / command line skills\n\n### 1. Installation\n\nInstall Plash comandline interface (CLI) with pip:\n\n``` sh\npip install plash-cli\n```\n\nThe CLI lets you manage your whole app\u2019s lifecycle\n\n### 2. CLI Login\n\nAuthenticate with your Plash account:\n\n``` sh\nplash_login\n```\n\nThis command opens your browser to authenticate with your Plash account.\nAfter completing the login process, you\u2019ll see a \u201ccomplete\u201d confirmation\npage in your browser.\n\nReturn to your terminal where you\u2019ll find the confirmation message:\n\n> Authentication successful! Config saved to\n> <your-global-config-path>/plash_config.json\n\n### 3. Create your first app\n\nCreate a new directory for your first app:\n\n``` bash\nmkdir -p plash-tutorial\ncd plash-tutorial\n```\n\nNext, create the `main.py` file:\n\n``` python\nfrom fasthtml.common import *\n\napp, rt = fast_app()\n\n@rt\ndef index():\n    return H1(\"Hello, world!\")\n\nserve()\n```\n\nThis is a basic [FastHTML](https://fastht.ml) app. Plash also supports\nother popular python frameworks.\n\n> [!WARNING]\n>\n> Your app must use port 5001, as this is the port exposed by Plash\u2019s\n> Docker container. It also happens to be the default for FastHTML apps.\n\nAnd create the `requirements.txt` file:\n\n``` python\npython-fasthtml\n```\n\n### 4. Deploy your app\n\nNow that you\u2019ve created your app files, you\u2019re ready to deploy! From\nyour `plash-tutorial` directory, run: `plash_deploy`\n\nThis command will:\n\n1.  Package your application files\n2.  Upload them to Plash\u2019s servers\n3.  Build and deploy your application\n\n``` bash\nplash_deploy\n```\n\n    Initializing deployment...\n    \u2705 Upload complete! Your app is currently being built.\n    It will be live at https://example-app.pla.sh\n\n**Note:** You\u2019ll see a different url that has been randomly generated\nfor your app.\n\n### 5. View your app\n\nYour app should be ready a couple of seconds after running the deploy\ncommand.\n\nOnce your app is ready, you can:\n\n1.  Open the provided URL in your browser, or\n2.  Use the convenient plash_view command to open it automatically:\n\n``` sh\nplash_view\n```\n\nWhen you visit that page you should see \u201cHello, World!\u201d\n\n\ud83c\udf89 Congratulations! You deployed your first app on Plash!\n\n## Where to go from here\n\nLearn more about what Plash has to offer in the rest of the docs at:\n<https://docs.pla.sh>\n\nFor learning more about creating web apps with FastHTML, we recommend\nlooking at the official docs at: <https://fastht.ml/docs/>.\n\nParticularly, we recommend the following:\n\n1.  [OAuth](https://fastht.ml/docs/explains/oauth.html) - Setup\n    authentication for your Plash App with Google Sign-In or other OAuth\n    Providers.\n2.  [Stripe](https://fastht.ml/docs/explains/stripe.html) - Accept\n    payments for your products hosted on Plash with Stripe.\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "CLI for the Plash hosting service",
    "version": "0.2.2",
    "project_urls": {
        "Homepage": "https://github.com/AnswerDotAI/plash_cli"
    },
    "split_keywords": [
        "nbdev",
        "jupyter",
        "notebook",
        "python"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ef4a6a93aa1753df6597f0c51efc87b01d9ff387fc6680fce15678523190403d",
                "md5": "95c4b8da41ac5005866f93a6bc823dcd",
                "sha256": "6ed2af218e00f69c10145ecdfcb9948a5fa0a46b7db46406474090d3142b15b5"
            },
            "downloads": -1,
            "filename": "plash_cli-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "95c4b8da41ac5005866f93a6bc823dcd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 14897,
            "upload_time": "2025-07-24T19:10:42",
            "upload_time_iso_8601": "2025-07-24T19:10:42.649334Z",
            "url": "https://files.pythonhosted.org/packages/ef/4a/6a93aa1753df6597f0c51efc87b01d9ff387fc6680fce15678523190403d/plash_cli-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a90047add504fe3d438cab1ea8124ac90222e3a1ca94b06e264dc0e5a50cad6f",
                "md5": "34868dfc7ec6eecc1d28da0c3670b738",
                "sha256": "f4c7fe75baec91f72b7c1bc8eebbf9d1b6b5b0658c2c10f586b1192ce814a5f2"
            },
            "downloads": -1,
            "filename": "plash_cli-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "34868dfc7ec6eecc1d28da0c3670b738",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 17680,
            "upload_time": "2025-07-24T19:10:43",
            "upload_time_iso_8601": "2025-07-24T19:10:43.926258Z",
            "url": "https://files.pythonhosted.org/packages/a9/00/47add504fe3d438cab1ea8124ac90222e3a1ca94b06e264dc0e5a50cad6f/plash_cli-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-24 19:10:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "AnswerDotAI",
    "github_project": "plash_cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "plash-cli"
}
        
Elapsed time: 0.95519s