Metadata-Version: 2.1
Name: tray-launcher
Version: 1.0.0
Summary: An icon resided in the task bar for managing .bat scripts.
Home-page: https://github.com/Jayich-Lab/tray-launcher/
Author: Huaxu Dan
Author-email: danhuaxutommy@gmail.com
License: UNKNOWN
Project-URL: Source Code, https://github.com/Jayich-Lab/tray-launcher/
Project-URL: Bug Tracker, https://github.com/Jayich-Lab/tray-launcher/issues/
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: ~=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# tray-launcher

[![Python: 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://docs.python.org/3.7/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI: tray-launcher](https://img.shields.io/pypi/v/tray-launcher)](https://pypi.org/project/tray-launcher/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

A launcher that resides in the Windows task bar for managing .bat scripts.

## Installation

*tray-launcher* can be installed with `pip install -i https://test.pypi.org/simple/ tray-launcher`.

## Usage

To start the *tray launcher*, first make sure you are in the Python environment variable where *tray-launcher* is installed. Then, running `launcher run` will show a small icon in the taskbar.

The *tray launcher* comes with a command line interface. Use `launcher -h` to learn more.

Before running any scripts from the tray launcher, they need to be loaded. This can be done by clicking the option **Load New Script(s)** in the contextmenu. Alternatively, paste scripts under `%USERPROFILE%\.tray_launcher\scripts`. Only *.bat* files are accepted.

To run a script, select it in the **Start a Script** submenu from the contextmenu, or click "View All" to see all loaded scripts in a file dialogue. 

Loggings of the *tray launcher* and the scripts you run will be saved under `%USERPROFILE%\.tray_launcher\logs`.

The *tray launcher* will list all scripts you started and are currently running. Move the cursor over to view more actions.

## Notes

1. The *tray launcher* only works on Windows. 

2. The *tray launcher* listens to `127.0.0.1:7686`. If this port is not available, the command line interface will not work. You need to go to control panel, create a new environment variable named `TRAY_LAUNCHER_PORT` and set its value to a port number that is available on your device.

3. If the *tray launcher* crashes, scripts started via the *tray launcher* will NOT be terminated.

4. There will be an expected delay when you run "launcher run".


