Metadata-Version: 2.4
Name: briefcase-pythonanywhere
Version: 0.0.1a2
Summary: A Briefcase publication channel plugin for deploying static web apps to PythonAnywhere.
Keywords: briefcase,pythonanywhere,deployment,web,static
Author: Filip Lajszczak
Author-email: Filip Lajszczak <filip@lajszczak.dev>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Requires-Dist: pythonanywhere-core>=0.3.0
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# briefcase-pythonanywhere

A [Briefcase](https://briefcase.readthedocs.io/) publication channel plugin for deploying static web apps to [PythonAnywhere](https://www.pythonanywhere.com/).

> **Note:** This package depends on the publication channels feature in Briefcase, which has not been included in a release yet. Until it is released, install Briefcase from main:
> ```
> pip install git+https://github.com/beeware/briefcase@main
> ```

## Prerequisites

* A PythonAnywhere account
* An API token (from your [Account page](https://www.pythonanywhere.com/account/#api_token))

## Installation

```console
$ pip install briefcase-pythonanywhere
```

## Quick start

Build and package your web app:

```console
$ briefcase create web static
$ briefcase build web static
$ briefcase package web static
```

Set your PythonAnywhere API token:

```console
$ export API_TOKEN=your-api-token-here
```

Publish:

```console
$ briefcase publish web static
```

Your app will be deployed to `https://<username>.pythonanywhere.com/`.

## Documentation

Full documentation is available at [https://briefcase.pythonanywhere.com/](https://briefcase.pythonanywhere.com/).

## Contributing

Development requires [uv](https://docs.astral.sh/uv/getting-started/installation/).

```console
$ git clone https://github.com/pythonanywhere/briefcase-pythonanywhere.git
$ cd briefcase-pythonanywhere
$ uv sync
$ uvx pre-commit install
$ uv run pytest
```

## License

MIT license.
