pyapp 0.29.0

Runtime installer for Python applications
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# Examples

-----

The following examples do not illustrate every possible combination of options but rather some common use cases.

## Single project basic

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |

## Single project embedded

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_PATH` | `./proj-X.Y.Z.dev0-py3-none-any.whl` |

## Dependency file basic

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_PROJECT_DEPENDENCY_FILE` | `./requirements.txt` |

!!! note
    The [default execution](config/project.md#execution-mode) will be `python -m proj` at runtime.

## Dependency file with script

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_PROJECT_DEPENDENCY_FILE` | `./requirements.txt` |
| `PYAPP_EXEC_SCRIPT` | `./script.py` |

## Execution with object reference

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_EXEC_SPEC` | `proj.cli:main` |

## Specific known distribution

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_PYTHON_VERSION` | `3.10` |

## Custom remote distribution basic

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_DISTRIBUTION_SOURCE` | `https://foo.bar.baz/archive.tar.gz` |

## Custom remote distribution embedded

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_DISTRIBUTION_SOURCE` | `https://foo.bar.baz/archive.tar.gz` |
| `PYAPP_DISTRIBUTION_EMBED` | `true` |

## Custom embedded local distribution

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_DISTRIBUTION_PATH` | `./archive.tar.gz` |

## Offline installation

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_PATH` | `./proj-X.Y.Z-py3-none-any.whl` |
| `PYAPP_DISTRIBUTION_PATH` | `./archive.tar.gz` |
| `PYAPP_PIP_EXTRA_ARGS` | `--no-deps` |

## Reproducible installation with custom package index

| Option | Value |
| --- | --- |
| `PYAPP_PROJECT_NAME` | `proj` |
| `PYAPP_PROJECT_VERSION` | `X.Y.Z` |
| `PYAPP_PROJECT_DEPENDENCY_FILE` | `./requirements.txt` |
| `PYAPP_PIP_EXTRA_ARGS` | `--only-binary :all: --index-url URL` |