forked from ppizarror/readme-generator
-
Notifications
You must be signed in to change notification settings - Fork 1
/
generator.pyw
625 lines (552 loc) · 23.3 KB
/
generator.pyw
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
# coding=utf-8
"""
README GENERATOR
Generate a README.md file from a configuration file
Autor: Pablo Pizarro R. @ ppizarror.com
Licencia:
The MIT License (MIT)
Copyright 2017 Pablo Pizarro R.
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.
"""
from __future__ import print_function
# noinspection PyCompatibility
from Tkinter import *
# noinspection PyCompatibility,PyUnresolvedReferences
import tkFont
# noinspection PyUnresolvedReferences,PyCompatibility
import tkMessageBox
# noinspection PyCompatibility
from tkFileDialog import askopenfilename
# Library imports
from PIL import ImageTk
from resources.content import *
from resources.utils import *
from resources.vframe import VerticalScrolledFrame
from subprocess import call
import codecs
import json
import sys
import time
import traceback
# noinspection PyBroadException
try:
import winsound
WSOUND_MODULE = True
except:
WSOUND_MODULE = False
# noinspection PyCompatibility
reload(sys)
# noinspection PyUnresolvedReferences
sys.setdefaultencoding('utf8')
# Constants
VERSION = '0.8.2'
# noinspection PyUnusedLocal,PyBroadException
class App(object):
"""
Main Application
"""
def __init__(self):
"""
Constructor.
"""
def _about():
"""
Print about on console.
:return:
"""
self._print(self._lang['ABOUT_APPTITLE'].format(VERSION))
self._print(self._lang['ABOUT_AUTHOR'] + '\n')
def _kill():
"""
Destroy the application.
:return:
"""
self._root.destroy()
exit()
def _scroll_console(event):
"""
Función que atrapa el evento del scrolling y mueve los comandos.
:param event: Evento
:return: None
"""
if 0 < event.x < 420 and 38 < event.y < 150:
if is_windows():
if -1 * (event.delta / 100) < 0:
move = -1
else:
move = 2
elif is_osx():
if -1 * event.delta < 0:
move = -2
else:
move = 2
else:
if -1 * (event.delta / 100) < 0:
move = -1
else:
move = 2
if len(self._console) < 5 and move < 0:
return
self._info_slider.canv.yview_scroll(move, 'units')
self._root = Tk()
self._root.protocol('WM_DELETE_WINDOW', _kill)
self._root.tk.call('tk', 'scaling', 1.35)
# Load configuration
with open('resources/config.json') as json_data:
d = json.load(json_data)
self._config = d
self._config['ROOT'] = str(os.path.abspath(os.path.dirname(__file__))).replace(
'\\', '/') + '/'
with open(self._config['LANG']) as json_data:
d = json.load(json_data)
self._lang = d
# Window properties
size = [self._config['APP']['WIDTH'], self._config['APP']['HEIGHT']]
self._root.minsize(width=size[0], height=size[1])
self._root.geometry('%dx%d+%d+%d' % (
size[0], size[1], (self._root.winfo_screenwidth() - size[0]) / 2,
(self._root.winfo_screenheight() - size[1]) / 2))
self._root.resizable(width=False, height=False)
self._root.focus_force()
# Window style
self._root.title(self._config['APP']['TITLE'])
self._root.iconbitmap(self._config['APP']['ICON']['TITLE'])
fonts = [tkFont.Font(family='Courier', size=8),
tkFont.Font(family='Verdana', size=6),
tkFont.Font(family='Times', size=10),
tkFont.Font(family='Times', size=10, weight=tkFont.BOLD),
tkFont.Font(family='Verdana', size=6, weight=tkFont.BOLD),
tkFont.Font(family='Verdana', size=10),
tkFont.Font(family='Verdana', size=7)]
f1 = Frame(self._root, border=5)
f1.pack(fill=X)
f2 = Frame(self._root)
f2.pack(fill=BOTH)
# Load file
self._loadbutton = Button(f1, text=self._lang['LOAD_FILE_BUTTON'], state='normal', relief=GROOVE,
command=self.load_file, cursor='hand2')
self._loadbutton.pack(side=LEFT, padx=5, anchor=W)
# Label that shows loaded configuration name
self._mainlabelstr = StringVar()
self._mainlabel = Label(f1, textvariable=self._mainlabelstr, foreground='#555', width=35,
anchor='w')
self._mainlabel.pack(side=LEFT, padx=3)
# Uploads
upimg = ImageTk.PhotoImage(
file=self._config['APP']['ICON']['UPLOADBUTTON'])
self._uploadbutton = Button(f1, image=upimg, relief=GROOVE, height=20,
width=20, border=0, state='disabled', command=self.upload)
self._uploadbutton.image = upimg
self._uploadbutton.pack(side=RIGHT, padx=2, anchor=E)
# Start process
self._startbutton = Button(f1, text=self._lang['START_PROCESS'],
state='disabled', relief=GROOVE,
command=self.start_process)
self._startbutton.pack(side=RIGHT, padx=5, anchor=E)
# Console
self._info_slider = VerticalScrolledFrame(f2)
self._info_slider.canv.config(bg='#000000')
self._info_slider.pack(pady=2, anchor=NE, fill=BOTH, padx=1)
self._info = Label(self._info_slider.interior, text='', justify=LEFT, anchor=NW,
bg='black', fg='white',
wraplength=self._config['APP']['WIDTH'],
font=fonts[0], relief=FLAT, border=2,
cursor='arrow')
self._info.pack(anchor=NW, fill=BOTH)
self._info_slider.scroller.pack_forget()
self._console = []
self._cnextnl = False
_about()
# Other variables
with open(self._config['LAST_SESSION_FILE']) as json_data:
lsession = json.load(json_data)
if lsession['LAST_FOLDER'] != '':
self._lastfolder = lsession['LAST_FOLDER']
else:
self._lastfolder = self._config['ROOT']
self._loadedfile = {}
self._generationok = False
self._lastloadedfile = ''
self._clearstatus()
# Events
self._root.bind('<MouseWheel>', _scroll_console)
def _clearstatus(self):
"""
Clear a loaded status.
:return: None
"""
self._uploadbutton.configure(state='disabled', cursor='arrow')
self._startbutton.configure(state='disabled', cursor='arrow')
self._mainlabelstr.set('')
self._loadedfile = {}
self._generationok = False
self._lastloadedfile = ''
def _clearconsole(self, scrolldir=1):
"""
Clear the console.
:param scrolldir: Scroll direction
:return:
"""
# noinspection PyShadowingNames,PyUnusedLocal
def _slide(*args):
"""
Mueve el scroll.
:return: None
"""
self._info_slider.canv.yview_scroll(1000 * scrolldir, 'units')
self._console = []
self._info.config(text='')
self._root.after(10, _slide)
def _errorsound(self):
"""
Create a error sound.
:return: None
"""
if self._config['APP']['SOUNDS'] and WSOUND_MODULE:
winsound.MessageBeep(1)
def load_file(self):
"""
Load a file to create README.md.
:return: None
"""
self._print(self._lang['LOAD_WAITING_USER'], end='', hour=True)
if self._config['REMEMBER_LAST_FOLDER']:
filename = askopenfilename(
title=self._lang['LOAD_FILE_PICKWINDOW_TITLE'],
filetypes=[(self._lang['LOAD_FILE_JSON'], '.json')],
initialdir=self._lastfolder)
else:
filename = askopenfilename(
title=self._lang['LOAD_FILE_PICKWINDOW_TITLE'],
filetypes=[(self._lang['LOAD_FILE_JSON'], '.json')])
# Check if filename is not empty
if filename == '':
self._print(self._lang['LOAD_CANCELLED'])
self._clearstatus()
return
else:
self._print(self._lang['PROCESS_OK'])
# Store last folder
filepath = os.path.split(filename)
self._lastfolder = filepath[0]
self._lastloadedfile = filepath[1]
# Validate file
self._print(self._lang['START_LOADING'].format(filename), hour=True, end='')
if self.validate(filename):
self._print(self._lang['LOAD_OK'])
self._uploadbutton.configure(state='disabled', cursor='arrow')
self._startbutton.configure(state='normal', cursor='hand2')
self._mainlabelstr.set(self._loadedfile['PROJECT']['NAME'])
if self._config['AUTO_START']:
self._root.after(50, self.start_process)
else:
self._clearstatus()
self._print(self._lang['LOAD_FAILED'].format(filename))
self.validate(filename, showerrors=True)
def _print(self, msg, hour=False, end=None, scrolldir=1):
"""
Print a message on console.
:param msg: Message
:param hour: Hour
:param scrolldir: Scroll direction
:return: None
"""
def _consoled(c):
"""
Generates string with hour of message.
:param c: List
:return: Text
"""
text = ''
for i in c:
text = text + i + '\n'
return text
def _get_hour():
"""
Return system hour.
:return: String
"""
return time.ctime(time.time())[11:19]
def _slide(*args):
"""
Scroll the console.
:return: None
"""
self._info_slider.canv.yview_scroll(2000 * scrolldir, 'units')
try:
msg = str(msg)
if hour:
msg = self._config['CONSOLE']['MSG_FORMAT'].format(_get_hour(), msg)
if len(self._console) == 0 or self._console[len(self._console) - 1] != msg:
if self._cnextnl:
self._console[len(self._console) - 1] += msg
else:
self._console.append(msg)
if end == '':
self._cnextnl = True
else:
self._cnextnl = False
if len(self._console) > self._config['CONSOLE']['LIMIT_MESSAGES_CONSOLE']:
self._console.pop()
self._info.config(text=_consoled(self._console))
self._root.after(50, _slide)
except:
self._clearconsole()
def start_process(self):
"""
Start generation process.
:return:
"""
self._print(self._lang['PROCESS_STARTED'], end='', hour=True)
try:
fl = open(self._lastfolder + '/README.md', 'w')
# Data variables
project = self._loadedfile['PROJECT']
icon = self._loadedfile['PROJECT']['ICON']
description = self._loadedfile['DESCRIPTION'].decode()
badges = self._loadedfile['BADGES']
badgelist = ''
badgelistcfg = self._loadedfile['BADGES'].keys()
for j in range(len(badgelistcfg)):
badgelistcfg[j] = int(badgelistcfg[j])
badgelistcfg.sort()
for j in range(len(badgelistcfg)):
badgelistcfg[j] = str(badgelistcfg[j])
for b in badgelistcfg:
if 'NEWLINE' in badges[b].keys() and badges[b]['NEWLINE']:
badgelist += '<br>'
elif 'SHOW' in badges[b].keys() and not badges[b]['SHOW']:
pass
else:
badgelist += CONTENT_BADGE_ITEM.format(badges[b]['HREF'], badges[b]['ALT'], badges[b]['IMAGE'])
author = self._loadedfile['AUTHOR']
author_section = author['SECTION']
contentreadme = open(self._lastfolder + '/' + self._loadedfile['CONTENT'])
# Write elements on README
if icon['IMAGE'] != '':
if self._loadedfile['PROJECT']['URL'] != '':
fl.write(CONTENT_HEADER_URL_IMAGE.format(project['URL'], project['URL_TITLE'], icon['ALT'],
icon['IMAGE'], project['NAME'], icon['WIDTH'],
icon['HEIGHT']))
else:
fl.write(CONTENT_HEADER_NO_URL_IMAGE.format(icon['ALT'], icon['IMAGE'], project['NAME'],
icon['WIDTH'], icon['HEIGHT']))
else:
if self._loadedfile['PROJECT']['URL'] != '':
fl.write(CONTENT_HEADER_URL_NO_IMAGE.format(project['URL'], project['URL_TITLE'], project['NAME']))
else:
fl.write(CONTENT_HEADER_NO_URL_IMAGE.format(project['NAME']))
if description != '':
fl.write(CONTENT_DESCRIPTION.format(description))
if badgelist != '':
fl.write(CONTENT_BADGES.format(badgelist))
fl.write('\n')
for line in contentreadme:
fl.write(line)
if author_section['SHOW']:
if author['DATE'] != '':
if author['URL'] != '':
fl.write(CONTENT_AUTHOR_SECTION_URL_DATE.format(author_section['TITLE'], author['URL'],
author['ALT'], author['NAME'], author['DATE']))
else:
fl.write(CONTENT_AUTHOR_SECTION_URL_DATE.format(author['NAME'], author['DATE']))
else:
if author['URL'] != '':
fl.write(CONTENT_AUTHOR_SECTION_URL_NO_DATE.format(author_section['TITLE'], author['URL'],
author['ALT'], author['NAME']))
else:
fl.write(CONTENT_AUTHOR_SECTION_NO_URL_NO_DATE.format(author['NAME']))
# Process finished
contentreadme.close()
fl.close()
self.save_last_session()
self._print(self._lang['PROCESS_OK'])
self._startbutton.configure(state='disabled', cursor='arrow')
self._uploadbutton.configure(state='normal', cursor='hand2')
self._generationok = True
# If auto upload
if self._config['AUTO_UPLOAD']:
self._root.after(50, self.upload)
except Exception as e:
self._errorsound()
self._print(self._lang['PROCESS_ERROR'])
self._print(str(e))
self._print(traceback.format_exc())
self._generationok = False
def run(self):
"""
Run the app.
:return: None
"""
self._root.mainloop()
def save_last_session(self):
"""
Save last opened folder to file.
:return:
"""
if self._config['SAVE_LAST_SESSION']:
with open(self._config['LAST_SESSION_FILE'], 'w') as outfile:
session = {
'LAST_FOLDER': self._lastfolder,
'LAST_LOADED_FILE': self._lastloadedfile
}
json.dump(session, outfile)
def upload(self):
"""
Upload README to github.
:return:
"""
def _callback():
try:
t = time.time()
with open(os.devnull, 'w') as FNULL:
with Cd(self._lastfolder):
call(['git', 'add', 'README.md'], stdout=FNULL, creationflags=CREATE_NO_WINDOW)
if self._config['COMMIT_ADD_ALL_FILES']:
call(['git', 'add', self._loadedfile['CONTENT']], stdout=FNULL,
creationflags=CREATE_NO_WINDOW)
call(['git', 'add', self._lastloadedfile], stdout=FNULL,
creationflags=CREATE_NO_WINDOW)
call(['git', 'commit', '-m', self._lang['COMMIT_UPDATE_README']], stdout=FNULL,
creationflags=CREATE_NO_WINDOW)
call(['git', 'push'], stdout=FNULL, stderr=FNULL, creationflags=CREATE_NO_WINDOW)
self._print(self._lang['COMMIT_TIME'].format((time.time() - t)))
self._root.configure(cursor='arrow')
self._loadbutton.configure(state='normal', cursor='hand2')
except Exception as e:
self._root.configure(cursor='arrow')
self._errorsound()
self._print(self._lang['PROCESS_ERROR'])
self._print(str(e))
self._print(traceback.format_exc())
if not self._generationok:
return
self._root.configure(cursor='wait')
self._uploadbutton.configure(state='disabled', cursor='arrow')
self._loadbutton.configure(state='disabled', cursor='arrow')
self._print(self._lang['COMMIT_STARTED'], end='', hour=True)
self._root.after(500, _callback)
def validate(self, configfile, showerrors=False):
"""
Validates a configfile.
:param showerrors: Show errors on console
:param configfile: Configuration file
:return:
"""
def print_error(error_id, formatstr=None):
"""
Print error on console.
:param formatstr: List to format
:param error_id: Error ID
:return: None
"""
if showerrors:
if formatstr is not None:
if type(formatstr) is list:
self._print('[CONFIG] ' + self._lang['FILE_ERRORS'][error_id].format(*formatstr))
else:
self._print('[CONFIG] ' + self._lang['FILE_ERRORS'][error_id].format(formatstr))
else:
self._print('[CONFIG] ' + self._lang['FILE_ERRORS'][error_id])
self._errorsound()
try:
with codecs.open(configfile, 'r', encoding='utf-8') as json_data:
cfg = json.load(json_data)
for c in ['PROJECT', 'AUTHOR', 'DESCRIPTION', 'BADGES', 'CONTENT']:
if c not in cfg.keys():
print_error('ELEMENT_NOT_FOUND', c)
if not showerrors:
return False
for c in ['NAME', 'ICON', 'URL', 'URL_TITLE']:
if c not in cfg['PROJECT'].keys():
print_error('PROJECT_ENTRY', c)
if not showerrors:
return False
for c in ['IMAGE', 'ALT', 'WIDTH', 'HEIGHT']:
if c not in cfg['PROJECT']['ICON'].keys():
print_error('PROJECT_ICON_ENTRY', c)
if not showerrors:
return False
if cfg['PROJECT']['ICON']['IMAGE'] != '':
if not str(cfg['PROJECT']['ICON']['WIDTH']).isdigit():
print_error('PROJECT_ICON_WIDTH', cfg['PROJECT']['ICON']['WIDTH'])
if not showerrors:
return False
if not str(cfg['PROJECT']['ICON']['HEIGHT']).isdigit():
print_error('PROJECT_ICON_HEIGHT', cfg['PROJECT']['ICON']['HEIGHT'])
if not showerrors:
return False
if cfg['PROJECT']['NAME'] == '':
print_error('PROJECT_EMPTY_NAME')
if not showerrors:
return False
for c in ['NAME', 'URL', 'ALT', 'DATE', 'SECTION']:
if c not in cfg['AUTHOR'].keys():
print_error('AUTHOR_ENTRY', c)
if not showerrors:
return False
for c in ['TITLE', 'SHOW']:
if c not in cfg['AUTHOR']['SECTION'].keys():
print_error('AUTHOR_SECTION_ENTRY', c)
if not showerrors:
return False
if cfg['AUTHOR']['SECTION']['SHOW']:
if cfg['AUTHOR']['SECTION']['TITLE'] == '':
print_error('AUTHOR_SECTION_EMPTY_IF_ENABLED')
if not showerrors:
return False
badges = cfg['BADGES']
for k in badges.keys():
if 'NEWLINE' not in badges[k].keys():
for c in ['IMAGE', 'HREF', 'ALT']:
if c not in badges[k].keys():
print_error('BADGE_ENTRY', [c, k])
if not showerrors:
return False
if badges[k]['IMAGE'] == '':
print_error('BADGE_IMAGE_EMPTY', k)
if not showerrors:
return False
else:
if not isinstance(badges[k]['NEWLINE'], bool):
print_error('MUST_BE_BOOL', 'NEWLINE')
if not showerrors:
return False
if not k.isdigit():
print_error('BADGE_TAG_NUMERIC', k)
if not showerrors:
return False
if cfg['CONTENT'] == '':
print_error('CONTENT_EMPTY')
if not showerrors:
return False
else:
filepath = os.path.split(configfile)
contentpath = filepath[0] + '/' + cfg['CONTENT']
if not os.path.isfile(contentpath):
print_error('CONTENT_FILE_NOT_EXIST', contentpath)
if not showerrors:
return False
self._loadedfile = cfg
return True
except Exception as e:
self._errorsound()
self._print(self._lang['PROCESS_ERROR'])
self._print(str(e))
self._print(traceback.format_exc())
return False
if __name__ == '__main__':
App().run()