-
Notifications
You must be signed in to change notification settings - Fork 0
/
.pypyreadme
164 lines (123 loc) · 6.13 KB
/
.pypyreadme
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
[](https://github.com/shollingsworth/pyquanda/issues) [](https://github.com/shollingsworth/pyquanda) [](https://github.com/shollingsworth/pyquanda/stargazers) [](https://github.com/shollingsworth/pyquanda/network/members)
[](https://pypi.org/project/pyquanda) [](https://pypi.org/project/pyquanda) [](https://pypi.org/project/pyquanda) [](https://pypi.org/project/pyquanda) [](https://pypi.org/project/pyquanda) [](https://pypi.org/project/pyquanda)
# TOC
* [PyQ[u]AndA](#pyq-u-anda-)
* [Installation / Quickstart](#installation---quickstart-)
* [License](#license-)
* [Other Docs](#other-docs-)
* [Command Help](#command-help-)
# PyQ[u]AndA [↑](#toc)
This is an interview environment based around xonsh, meant to be used via
SSH and wrapped around custom hooks you define
Pull requests welcome!
## Installation / Quickstart [↑](#toc)
To install this package from [pypy](https://pypi.org/project/pyquanda/) run the following command.
```
pip3 install pyquanda
```
```
pyquanda-cmd demo
```
## License [↑](#toc)
See: [LICENSE](https://github.com/shollingsworth/pyquanda/blob/main/LICENSE)
## Other Docs [↑](#toc)
* [Api Docs](./docs/documentation.md)
* [Changelog](https://github.com/shollingsworth/pyquanda/blob/main/CHANGELOG.md)
## Command Help [↑](#toc)
# Main
## new
```
usage: gendoc.py new [-h] [--overwrite] --destination_directory DESTINATION_DIRECTORY {system,intro,problem} name description
create a new module from templates
positional arguments:
{system,intro,problem}
module type
name module name
description module name
optional arguments:
-h, --help show this help message and exit
--overwrite automatically overwrite destination directory
--destination_directory DESTINATION_DIRECTORY, -d DESTINATION_DIRECTORY
src_module_dir help
```
## a_single
```
usage: gendoc.py a_single [-h] [-c INTERVIEW_CONFIG_YAML] -s SRC_MODULE_DIR [--debug]
run ansible on a single module based on path
optional arguments:
-h, --help show this help message and exit
-c INTERVIEW_CONFIG_YAML, --interview_config_yaml INTERVIEW_CONFIG_YAML
starting configuration yaml
-s SRC_MODULE_DIR, --src_module_dir SRC_MODULE_DIR
source module directory
--debug debug output, do not execute
```
## a_all
```
usage: gendoc.py a_all [-h] [-c INTERVIEW_CONFIG_YAML] -s SRC_MODULE_DIR [--debug]
run all ansible modules in path
optional arguments:
-h, --help show this help message and exit
-c INTERVIEW_CONFIG_YAML, --interview_config_yaml INTERVIEW_CONFIG_YAML
starting configuration yaml
-s SRC_MODULE_DIR, --src_module_dir SRC_MODULE_DIR
source module directory
--debug debug output, do not execute
```
## q_save
```
usage: gendoc.py q_save [-h] [-c INTERVIEW_CONFIG_YAML] -s SRC_MODULE_DIR [--destination_directory DESTINATION_DIRECTORY]
convert questions to pyquanda questions config file
optional arguments:
-h, --help show this help message and exit
-c INTERVIEW_CONFIG_YAML, --interview_config_yaml INTERVIEW_CONFIG_YAML
starting configuration yaml
-s SRC_MODULE_DIR, --src_module_dir SRC_MODULE_DIR
source module directory
--destination_directory DESTINATION_DIRECTORY, -d DESTINATION_DIRECTORY
src_module_dir help
```
## q_test
```
usage: gendoc.py q_test [-h] -s SRC_MODULE_DIR [-c INTERVIEW_CONFIG_YAML] [--keep_state]
test question set
optional arguments:
-h, --help show this help message and exit
-s SRC_MODULE_DIR, --src_module_dir SRC_MODULE_DIR
source module directory
-c INTERVIEW_CONFIG_YAML, --interview_config_yaml INTERVIEW_CONFIG_YAML
starting configuration yaml
--keep_state, -k keep state (defaults to False)
```
## userdata
```
usage: gendoc.py userdata [-h] [-c INTERVIEW_CONFIG_YAML] -s SRC_MODULE_DIR --destination_directory DESTINATION_DIRECTORY
save userdata zip file in directory (filename: userdata.zip)
optional arguments:
-h, --help show this help message and exit
-c INTERVIEW_CONFIG_YAML, --interview_config_yaml INTERVIEW_CONFIG_YAML
starting configuration yaml
-s SRC_MODULE_DIR, --src_module_dir SRC_MODULE_DIR
source module directory
--destination_directory DESTINATION_DIRECTORY, -d DESTINATION_DIRECTORY
src_module_dir help
```
## bootstrap
```
usage: gendoc.py bootstrap [-h] userdata_file
bootstrap host given userdata.zip file
positional arguments:
userdata_file
optional arguments:
-h, --help show this help message and exit
```
## demo
```
usage: gendoc.py demo [-h] [--destination_directory DESTINATION_DIRECTORY] [--overwrite]
demonstrate the xonsh question environment
optional arguments:
-h, --help show this help message and exit
--destination_directory DESTINATION_DIRECTORY, -d DESTINATION_DIRECTORY
src_module_dir help
--overwrite automatically overwrite destination directory
```