-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.py
387 lines (321 loc) · 9.46 KB
/
docs.py
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# Contains the help text of S3 and a function to render it.
# Help Contents are hardcoded so that it is easier to make a portable executable without any data file.
from rich.markdown import Markdown
primary_help_md = """
# HELP - S3 (Simplified SQL Shell)
## Regular SQL Commands
Just type in your required SQL Command and press enter.
Multiline SQL Statements are supported, just press enter and don't end the statement with semicolon ';' until you want to end it.
> Don't Forget Semicolon at the end of every statement.
For SQL Specific Documentation refer to :
1. MySQL Docs - https://dev.mysql.com/doc/
2. MariaDB Docs - https://mariadb.org/documentation/
## Shortcut SQL Commands
Shortcuts is a special feature of S3 that helps to dramatically reduce the length of the SQL statements that you type.
> Using Semicolons ';' to end shortcuts is not mandatory.
0. Set the Database that you wanna use (Obvious Stuff !!)
```
USE <DATABASE_NAME>
```
1. Set The Table for Shortcut Commands. (Not Mandatory, but Recommended)
It saves typing the table name everytime !
```
!t <table_name>
```
2. Use the Shortcuts !
Example Usage -
```
!s
```
Is Equivalent to running
```
SELECT * FROM <table_name>;
```
Just see How much you need not type !
For more help about Shortcuts, refer to Shorcut Manual by -
```
help shortcuts;
```
## App Commands
### Exit
To exit the app, just type
```
exit;
```
and press enter.
### About
To know about the app, just type
```
about;
```
and press enter
"""
shortcuts_help_md = """
# SHORCUT MANUAL - S3 (Simplified SQL Shell)
Shortcuts is a special feature of S3 that helps to dramatically reduce the length of the SQL statements that you type. Shortcuts is currently only available for a handful of SQL Commandd.
> Using Semicolons ';' to end shortcuts is not mandatory. Also, Shortcuts are NOT CASE SENSITIVE (even the arguments !).
## Beware about arguments of Shortcuts.
***Arguments that have multiple things seperated by commas SHOULD NOT have spaces between them. It will either not work or produce Unintended [Absurd !] results.***
## Set Table Shortcut
**Usage-**
Just
```
!t <Table_Name>
```
That's It !
## Show Shortcut
**Usage -**
```
!sh <arg1>
```
- arg1 [optional] - Table or Database, **Default - t**
**Values -**
**d**: database
**t**: tables
## Select Shortcut
**Usage-**
```
!s <arg1> <arg2>
```
- arg1 [optional] - Set the fields you want to retrieve, * is default, field names are comma-seperated **with no spaces** between them.
- arg2 [optional] - Set Table name, use this if you haven't set the table using !t or you want to just overide it.
## Describe Shortcut
**Usage-**
```
!d <arg1>
```
- arg1 [optional] - Set Table name, use this if you haven't set the table using !t or you want to just overide it.
## Insert Shortcut
**Usage-**
```
!i <arg1> <arg2> <arg3>
```
- arg1 [Mandatory] - Set the values to insert into the table. Values are comma-seperated **with no spaces** between them.
- arg2 [Optional] - Set the field names into which the command needs to be inserted. Field names are comma-seperated **with no spaces** between them.
- arg3 [Optional] - Set Table name, use this if you haven't set the table using !t or you want to just overide it.
## Auto Insert Shorcut
Definetely, one of the coolest feature of S3, very useful if you want to insert a bunch of random values super-quickly into your database !
It uses the **Faker** Library and **Python's Random Library** to generate data according to your requirements !
> Prior !t usage is mandatory.
**Usage-**
```
!ai <arg1> **args
```
> Run !d before you use autoinsert to avoid errors in using this feature.
- arg1 [Mandatory] - Set the number of entries you want to insert.
- **args - Set the Data Type that you want to insert into this field.
Example usage of Auto-Insert -
```
!ai 5 num(2) name(nb) num(20000, 30000) phone addr bool yn gender null
```
### Supported Data Types for Auto Insert -
> For the arguments of the datatypes, use parenthesis '()' and arguments are comma-seperated **with no spaces** between them.
#### Name
**Datatype - String (Char, Varchar, whatever you wanna call it !)**
Generates Random Person Names based on locale.
1. Full Name
```
name(arg1)
```
- arg1 [optional] - Set the gender for name. **Default-Random**
**Values -**
**m**: male
**f**: female
**nb**: non-binary
2. First Name
```
fname(arg1)
```
- arg1 [optional] - Same as Full Name
3. Last Name
```
lname(arg1)
```
- arg1 [optional] - Same as Full Name
> If you use name and lname, fname then they won't match !
#### Number
**Datatype - Integer**
Number Datatype is slightly special, in the sense, different number of argument will yield different results.
1. With 0 Arguments
Will Generate A Random Integer between 0 and 1000.
```
num
```
2. With 1 Argument
Argument is taken as the number of digits.
```
num(3)
```
A 3 digit number is generated.
3. With 2 Arguments
Arguments are taken as the range from which the digits should be generated.
```
num(100,500)
```
This will generate a number between 100 and 500
Again, **No Spaces** between the comma seperated arguments or else it will produce insanely absurd results !!
***So, Don't Do This* !**
```
num(100, 500)
```
> You can also use '**int**' instead of '**num**' in all the above commands.
#### Date
**Datatype - Date**
Generates a date in default SQL Format.
```
date(arg1,arg2)
```
- arg1 [optional] - Set the Starting Year. **Default-1970**
- arg2 [optional] - Set the Ending Year. **Deafult-Present-Year**
#### Date Of Birth
**Datatype - Date**
Generates a date of birth in default SQL date Format.
```
dob(arg1,arg2)
```
- arg1 [optional] - Set the Minimum Age. **Default-0**
- arg2 [optional] - Set the Maximum Age. **Deafult-115**
#### Color
**Datatype - String**
Generates a random color name.
```
color
```
> **colour** can also be used instead of **color**
#### Phone Number
**Datatype - String**
Generates a phone number based on locale.
```
phone
```
#### Address
**Datatype - String**
Generates a random address based on locale.
```
addr
```
#### City
**Datatype - String**
Generates a random city name according to locale.
```
city
```
#### Country
**Datatype - String**
Generates a random country name.
```
country
```
#### Pincode
**Datatype - String**
Generates a random pincode [or postcode] according to the locale.
```
pincode
```
#### Boolean Values
**Datatype - Bool**
Generates Either True or False.
```
bool
```
#### Yes or No
**Datatype - String**
Generates Yes or No
```
yn
```
#### Gender
**Datatype - String**
Generates Male or Female
```
gender
```
#### Null
**Datatype - Null**
Sets the field to null.
```
null
```
> Even **'none'** can be used instead of **'null'**
#### Aadhaar Number (Only for Indian Locale)
**Datatype - String**
Generates a random aadhaar number
```
aadhaar
```
#### Company
**Datatype - String**
Generates a random company name.
```
company
```
#### Language Name
**Datatype - String**
Generates a random language name.
```
language
```
#### In All Other Cases
Incase you do this -
```
!ai 10 num(2) name num(1) abc addr
```
Here **abc** is not a datatype. So **abc** will be considered as the default value for all the 4th field of 10 rows.
> Only String Values are supported for Default Value. Incase you enter a number, it will be converted into a string. So don't use this with a field of number datatype.
## Set Shortcut Locale
**Default Locale is en_IN [India]**
```
!l <locale>
```
Example -
```
!l en_US
```
> For Supported Locale types refer to Faker Documentations(https://faker.readthedocs.io/en/master/locales.html) .
"""
about_md = """
# ABOUT - S3 (Simplified SQL Shell)
## Author - R Uthaya Murthy (https://github.com/Uthayamurthy)
## Version - 1.0
## Source - https://github.com/Uthayamurthy/S3
## License - MIT License
***S3 is a SQL Shell for MariaDB and MySQL.
It comes with a Colorful CLI (emojis too !) and has shortcuts that can help to greatly shorten your SQL Commands.***
> Primarily Intended For Educational Purposes Only.
To Know More About Licensing Terms, Run -
```
about license;
```
"""
license_md = """
# License - S3 (Simplified SQL Shell)
## MIT License
> Copyright (c) 2023 R Uthaya Murthy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
def app_help(typ='gen'):
global primary_help_md, shortcuts_help_md
if typ == 'gen':
return Markdown(primary_help_md)
elif typ == 'shortcuts':
return Markdown(shortcuts_help_md)
def app_about(typ='gen'):
global about_md, license_md
if typ == 'gen':
return Markdown(about_md)
elif typ == 'license':
return Markdown(license_md)