Skip to content

Commit e7b5e5b

Browse files
committed
Latest readme creator flies
1 parent 314d6e4 commit e7b5e5b

File tree

8 files changed

+4331
-4762
lines changed

8 files changed

+4331
-4762
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
readme_creator/psg_gui.py

readme_creator/1_HEADER_top_part.md

+81-43
Large diffs are not rendered by default.

readme_creator/2_readme.md

+214-133
Large diffs are not rendered by default.

readme_creator/4_Release_notes.md

+50-1
Original file line numberDiff line numberDiff line change
@@ -1093,7 +1093,7 @@ Quick patch to remove change to popup
10931093
Quick patch to remove f-string for 3.5 compat.
10941094

10951095

1096-
## 4.16.0 PySimpleGUI 08-Jan-2020
1096+
## 4.16.0 PySimpleGUI 20-Feb-2020
10971097

10981098
The "LONG time coming" release. System Tray, Read with close + loads more changes
10991099
Note - there is a known problem with the built-in debugger created when the new read with close was added
@@ -1124,6 +1124,55 @@ Note - there is a known problem with the built-in debugger created when the new
11241124
* print_to_element - print-like call that can be used to output to a Multiline element as if it is an Output element
11251125

11261126

1127+
## 4.17.0 PySimpleGUI 24-Mar-2020
1128+
1129+
The "it's been a minute" release
1130+
Improved DocStrings and documentation!
1131+
Upgrade utility
1132+
"Printing" directly to Multiline
1133+
1134+
* New upgrade utility to upgrade your installed package using GitHub version
1135+
* Can invoke from command line. Run `python -m PySimpleGUI.PySimpleGUI upgrade`
1136+
* The test harness GUI has an upgrade button
1137+
* Multiline.print - Add multiline element to the front of any print statement. Also supports color output
1138+
* Debug informmation like path and version displayed in test harness GUI
1139+
* Added back the TRANSPARENT_BUTTON variable until can find a better way to deprecate
1140+
* All elements were losing padding when made invisible. Fixed
1141+
* Image.update - fixed crash due to not checking for type before getting size
1142+
* Image.update_animation_no_buffering - playback GIF animations of any length
1143+
* Graph element - Fixed divide by zero error in convert function
1144+
* TabGroup will now autonumber keys if none specified
1145+
* Measuring strings more accurately during layout
1146+
* Using specific font for measurement
1147+
* Used to compute TTK button height
1148+
* Used to compute Slider length
1149+
* Used to compute header widths in Tables, Trees
1150+
* Used to compute column widths in Tables, Trees
1151+
* Used to compute row heights in Tables
1152+
* Removed padx from row frames. Was using window's margins. Now padx & pady = 0. Was causing too every Column element to have extra padding
1153+
* Added no_titlebar to one line progress meter
1154+
* popup_notify - Creates a "notification window" that is like the System Tray Message window
1155+
* shell_with_animation - launch a shell command that runs while an animated GIF is shown
1156+
* Fixed problem with debugger not working after the recent close parameter addition to Window.read
1157+
1158+
1159+
## 4.18.0 PySimpleGUI 26-Mar-2020
1160+
1161+
An "Oh F**k" Release - Table column sizes were bad
1162+
1163+
* Fixed bug in Table Element's column size computation
1164+
* popup_animated has new title parameter
1165+
* Checkbox - update can change the text
1166+
1167+
1168+
## 4.18.1 PySimpleGUI 12-Apr-2020
1169+
1170+
Emergency patch - f-string managed to get into the code resulting crashes on 3.5 systems (Pi's for example)
1171+
1172+
## 4.18.2 PySimpleGUI 12-Apr-2020
1173+
1174+
The Epic Fail release.... import error on 3.5 for subprocess.
1175+
11271176

11281177

11291178
### Upcoming

readme_creator/Makefile

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
build:
2+
python3 make_real_readme.py
3+
rm usage.log.txt
4+
5+
build2:
6+
python3 make_real_readme.py
7+
8+
clean:
9+
rm usage.log.txt

readme_creator/PySimpleGUIlib.py

+174-106
Large diffs are not rendered by default.

readme_creator/readme.md

+3,701-4,479
Large diffs are not rendered by default.

readme_creator/usage.py

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
from make_real_readme import main
2+
3+
########################################################################
4+
# __ _ _ #
5+
# / _(_) | | #
6+
# __ __ ___ ___ _ __ | |_ _ __ _ | |__ ___ _ __ ___ #
7+
# \ \ / / / __/ _ \| '_ \| _| |/ _` | | '_ \ / _ \ '__/ _ \ #
8+
# \ V / | (_| (_) | | | | | | | (_| | | | | | __/ | | __/ #
9+
# \_/ \___\___/|_| |_|_| |_|\__, | |_| |_|\___|_| \___| #
10+
# __/ | #
11+
# |___/ #
12+
########################################################################
13+
OUTPUT_FILENAME = 'readme.md'
14+
15+
##-#-#-# ##-#-#-#
16+
# Pre-process logic
17+
##-#-#-# ##-#-#-#
18+
19+
line_break = '<br>'
20+
# line_break can be:
21+
# - '<br>'
22+
# - ' \n '
23+
24+
method = 'with logs'
25+
# method can be:
26+
# - 'simple, no log'
27+
# - 'with logs'
28+
29+
30+
##-#-#-# ##-#-#-#
31+
# Post-process logic
32+
##-#-#-# ##-#-#-#
33+
enable_popup = True
34+
insert_md_section_for__class_methods = False
35+
remove_repeated_sections_classmethods = False
36+
37+
38+
39+
##############
40+
# __ #
41+
# /_ | #
42+
# | | #
43+
# | | #
44+
# | | #
45+
# |_| #
46+
##############
47+
if method == 'simple, no log':
48+
main(logger=None,
49+
insert_md_section_for__class_methods=insert_md_section_for__class_methods,
50+
remove_repeated_sections_classmethods=remove_repeated_sections_classmethods,
51+
files_to_include=[0, 1, 2, 3],
52+
output_name=OUTPUT_FILENAME,
53+
delete_html_comments=True)
54+
55+
################
56+
# ___ #
57+
# |__ \ #
58+
# ) | #
59+
# / / #
60+
# / /_ #
61+
# |____| #
62+
################
63+
if method == 'with logs':
64+
65+
import logging
66+
logger = logging.getLogger(__name__)
67+
logger.setLevel(logging.DEBUG)
68+
69+
my_file = logging.FileHandler('usage.log.txt', mode='w')
70+
my_file.setLevel(logging.DEBUG)
71+
formatter = logging.Formatter('%(asctime)s>%(levelname)s: %(message)s')
72+
my_file.setFormatter(formatter)
73+
logger.addHandler(my_file)
74+
logger.info('STARTING')
75+
76+
main(logger=logger,
77+
insert_md_section_for__class_methods=insert_md_section_for__class_methods,
78+
remove_repeated_sections_classmethods=remove_repeated_sections_classmethods,
79+
files_to_include=[0, 1, 2, 3],
80+
output_name=OUTPUT_FILENAME,
81+
delete_html_comments=True)
82+
83+
########################################
84+
# _____ #
85+
# | __ \ #
86+
# | |__) |__ _ __ _ _ _ __ #
87+
# | ___/ _ \| '_ \| | | | '_ \ #
88+
# | | | (_) | |_) | |_| | |_) | #
89+
# |_| \___/| .__/ \__,_| .__/ #
90+
# | | | | #
91+
# |_| |_| #
92+
########################################
93+
if enable_popup:
94+
import PySimpleGUI as sg
95+
96+
with open('usage.log.txt', 'r') as ff:
97+
lines = ff.read()
98+
sg.PopupScrolled('Completed making ' + OUTPUT_FILENAME, lines, size=(80,50))
99+
100+

0 commit comments

Comments
 (0)