summaryrefslogtreecommitdiffstats
path: root/docs/api/scripts.md
blob: 470d13e907cfb684f27476807ffb62fe626adb8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
```{caution}
This API is not finalised, and may change in a patch version.
```

# `installer.scripts`

Provides the ability to generate executable launcher scripts, that are based on
[`simple_launcher`]. A description of how these scripts work is available in
simple_launcher's README.

[`simple_launcher`]: https://bitbucket.org/vinay.sajip/simple_launcher/

```{eval-rst}
.. autoclass:: installer.scripts.InvalidScript()

.. autoclass:: installer.scripts.Script()
    :special-members: __init__
    :members:
```