Metadata-Version: 2.5
Name: libreflow_launcher
Version: 1.4.1
Summary: Launcher for instances of Libreflow asset-manager
Project-URL: Repository, https://gitlab.com/lfs.coop/libreflow/libreflow_launcher
Project-URL: Changelog, https://gitlab.com/lfs.coop/libreflow/libreflow_launcher/-/raw/main/CHANGELOG.md
Author-email: Valentin Braem <valentin.braem@les-fees-speciales.coop>
License-Expression: LGPL-3.0-or-later
Keywords: animation,asset-manager,cgwire,gazu,kabaret,kitsu,launcher,lfs,libreflow,overseer,pipeline
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Multimedia
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.10
Requires-Dist: applescript; sys_platform == 'darwin'
Requires-Dist: pyside6
Requires-Dist: qtpy
Requires-Dist: requests
Requires-Dist: tomli; python_version < '3.11'
Description-Content-Type: text/markdown

# Libreflow Launcher

Libreflow Launcher is a startup program for instances of [Libreflow](https://gitlab.com/lfs.coop/libreflow/libreflow).

This application communicates with one or more [Overseer](https://gitlab.com/lfs.coop/overseer) servers and gives users access to the projects (libreflow instances) assigned to them.

Each instance is installed locally with [uv](https://github.com/astral-sh/uv). Its configuration is resolved by Overseer according to the project, site and user, which also determines how the Python virtual environment is set up.

## Requirements

- Python 3.9 or above
- [uv](https://github.com/astral-sh/uv) to manage Python versions and the per-project virtual environments
- Access to an Overseer server

## Run

```
libreflow_launcher --site sitename
```

Arguments:

> `--site sitename` : define which working site to use

## Dedicated install scripts

On the install folder, you have dedicated install scripts meant for artists' workstations. On top of installing the launcher itself, it takes care of the whole environment a Libreflow project may need:

- installs `uv` and a compatible Python version if missing
- installs `ffmpeg` to convert rendered image sequences into movies
- optionally installs the TVPaint RPC plugin and/or the Blender `mark-sequence` add-on
- generates a bat or bash shortcut pointing at the chosen site and starts it, so artists don't need to touch a terminal afterwards

It's recommended to run the script with elevated rights.
