blob: 7846513e0a9639dbeb2a7bb239d7d42ab0f4e48b (
plain)
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
|
---
hide-toc: true
---
# Welcome to installer's documentation
```{include} ../README.md
:start-after: <!-- start readme-pitch -->
:end-before: <!-- end readme-pitch -->
```
```{toctree}
:hidden:
concepts
```
```{toctree}
:caption: API reference
:hidden:
:glob:
api/*
```
```{toctree}
:caption: CLI reference
:hidden:
:glob:
cli/*
```
```{toctree}
:caption: Project
:hidden:
development/index
changelog
license
GitHub <https://github.com/pradyunsg/installer>
PyPI <https://pypi.org/project/installer>
```
## Basic Usage
```python
import sys
import sysconfig
from installer import install
from installer.destinations import SchemeDictionaryDestination
from installer.sources import WheelFile
# Handler for installation directories and writing into them.
destination = SchemeDictionaryDestination(
sysconfig.get_paths(),
interpreter=sys.executable,
script_kind="posix",
)
with WheelFile.open("sampleproject-1.3.1-py2.py3-none-any.whl") as source:
install(
source=source,
destination=destination,
# Additional metadata that is generated by the installation tool.
additional_metadata={
"INSTALLER": b"amazing-installer 0.1.0",
},
)
```
|
