ipyrun 0.6.2
template UI (ipywidgets / ipyautoui) for running python scripts in jupyterlab / voila.
Keywords: ipyrun

# ipyrun

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyrun/HEAD)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

![ipyrun-logo](images/logo.png)

ipyrun is UI first package built on ipywidgets designed for rapidly creating an app user interface for use in a
jupyter notebook / lab or voila app. To run a script or process and generate resultant output files.
The app caches input, output and runtime data, such that the previous state of the app is available to the user when returning.

## Try it online!

launch [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/maxfordham/ipyrun/HEAD) <-- TODO: make this work! (need to build ipyautoui)

## Screenshots

The example below shows the simple example of using the `ipyrun` to create an App for plotting straight line
graphs, storing the input and output data for multiple runs. This is a useless example, but `ipyrun` can be
programmed to complete any process creating user-defined input files and output files.

![simple-linegraph-app](images/simple-linegraph-app.gif)

## Description

A generic user interface for running processes.
Data inputs to the process are defined by standard datafiles (e.g. csv, json), and data files are generated as outputs when the script is run.
A timestamped record of script execution is maintained.
An ipywdiget user interface allows users to edit script input data and view outputs of script execution.

## User Journey to Creating an App with the DefaultAppConfig

The rationale behind ipyrun is that by following the simple process outlined below, the user does not need to think
too much about creating an interface or how to cache data, with this being templated by the ipyrun configuration.

ipyrun is "UI first",  upon which different, user-applied configurations can be attached. ipyrun ships with a
`DefaultRunConfig` that is intended for executing python scripts or packages. New users are recommended to use
this configuration, creating new configurations is an "advanced feature" that would require digging around the 
source code to ensure understand the relationships between the `config`, `actions` and `ui`.

```{note}
it is possible to set up new ipyrun configurations, that might have different execute commands. 
for example it would be great to create a `RunSnake` app for executing SnakeMake commands... 
```

|     |                                     |                                                            |
| --- | ----------------------------------- | ---------------------------------------------------------- |
| 1   | ![](images/pydantic-jsonschema.png) | __create an input schema__                                 |
| 2   | ![](images/logo-ipyautoui.png)      | __generate an input form using ipyautoui__                 |
| 3   | ![](images/script-or-package.png)   | __create a script or process to execute__                  |
| 4   | ![](images/logo.png)                | __create a RunApp instance to manage UI and data-caching__ |

## Install

```bash
pip install ipyrun
```

## Develop

```bash
mamba env create -f environment-dev.yml 
pytest
```

## Packaging and Publish

```sh
#  NOTE: restricted to core-maintainers only
mamba activate hatcher # or conda env with hatch installed
hatch build  # builds to local folder
hatch publish -u __token__ -a <your-pypi-token>  # publishes to pypi
```