Skip to content

Commit b81bd97

Browse files
committed
Release of the PSG5 version
0 parents  commit b81bd97

13 files changed

Lines changed: 1887 additions & 0 deletions

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Contributing to PySimpleGUI
2+
3+
We are happy to receive issues describing bug reports and feature requests! If your bug report relates to a security vulnerability, please do not file a public issue, and please instead reach out to us at issues@PySimpleGUI.com.
4+
5+
We do not accept (and do not wish to receive) contributions of user-created or third-party code, including patches, pull requests, or code snippets incorporated into submitted issues. Please do not send us any such code! Bug reports and feature requests should not include any source code.
6+
7+
If you nonetheless submit any user-created or third-party code to us, (1) you assign to us all rights and title in or relating to the code; and (2) to the extent any such assignment is not fully effective, you hereby grant to us a royalty-free, perpetual, irrevocable, worldwide, unlimited, sublicensable, transferrable license under all intellectual property rights embodied therein or relating thereto, to exploit the code in any manner we choose, including to incorporate the code into PySimpleGUI and to redistribute it under any terms at our discretion.

LICENSE.txt

Lines changed: 588 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<p align="center">
2+
<p align="center"><img width="238" height="135" src="https://pysimplegui.net/images/logos/psglogofull.svg"><p>
3+
4+
<h2 align="center">psgfiglet</h2>
5+
<h2 align="center">A PySimpleGUI Application</h2>
6+
</p>
7+
8+
Create Figlets
9+
10+
```text
11+
______ _ _ _
12+
| ____(_) | | | |
13+
| |__ _ __ _| | ___| |_ ___
14+
| __| | |/ _` | |/ _ \ __/ __|
15+
| | | | (_| | | __/ |_\__ \
16+
|_| |_|\__, |_|\___|\__|___/
17+
__/ |
18+
|___/
19+
```
20+
```text
21+
_ ___ __ _ _ ___ _____
22+
| |__ _ _ / _ \_ _/ _\(_)_ __ ___ _ __ | | ___ / _ \/\ /\ \_ \
23+
| '_ \| | | | / /_)/ | | \ \ | | '_ ` _ \| '_ \| |/ _ \/ /_\/ / \ \ / /\/
24+
| |_) | |_| | / ___/| |_| |\ \| | | | | | | |_) | | __/ /_\\\ \_/ /\/ /_
25+
|_.__/ \__, | \/ \__, \__/|_|_| |_| |_| .__/|_|\___\____/ \___/\____/
26+
|___/ |___/ |_|
27+
```
28+
29+
30+
31+
32+
33+
<p align="center"><img width="850" height="429" src="screenshot.png"><p>
34+
35+
36+
37+
38+
39+
40+
41+
## Features
42+
43+
* Retro ASCII ART
44+
* Create big block letters composed of smaller characters
45+
* Choose from dozens of fonts
46+
* Copy and paste into your documents and code
47+
48+
49+
## Installation
50+
51+
### Using PIP with PyPI
52+
53+
The latest official release of PySimpleGUI products can be found on PyPI. To pip install the demo applications from PyPI, use this command
54+
55+
#### If you use the command `python` on your computer to invoke Python (Windows):
56+
57+
`pip install --upgrade psgfiglet`
58+
59+
#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):
60+
61+
`pip3 install --upgrade psgfiglet`
62+
63+
### Using PIP with GitHub
64+
65+
You can also pip install the PySimpleGUI Applications that are in the PySimpleGUI GitHub account. The GitHub versions have bug fixes and new programs/features that have not yet been released to PyPI. To directly pip install from that repo:
66+
67+
#### If you use the command `python` on your computer to invoke Python (Windows):
68+
69+
```bash
70+
python -m pip install --upgrade https://github.com/PySimpleGUI/psgfiglet/zipball/main
71+
```
72+
73+
#### If you use the command `python3` on your computer to invoke Python (Linux, Mac):
74+
75+
```bash
76+
python3 -m pip install --upgrade https://github.com/PySimpleGUI/psgfiglet/zipball/main
77+
```
78+
79+
80+
## Usage
81+
82+
Once installed, launch psgfiglet by typing the following in your command line:
83+
84+
`psgfiglet`
85+
86+
## About - What is a Figlet?
87+
88+
A Figlet is a text based way to add large block text to your code or chats. There are a variety of "Fonts" available that you'll find listed along the left side of the screen.
89+
90+
![image](https://user-images.githubusercontent.com/46163555/136379651-58f474d7-fbfa-423f-a5da-162d6936d104.png)
91+
92+
## To use in your code
93+
94+
The easiest way to is make a multiline string in your code using triple quotes:
95+
96+
```python
97+
98+
'''
99+
This is a multiline string
100+
Line 2
101+
'''
102+
```
103+
104+
105+
You can simply paste your Figlet into one of these multiline comments. They work well at breaking up your code into chunks
106+
107+
```python
108+
109+
'''
110+
oo
111+
112+
88d8b.d8b. .d8888b. dP 88d888b.
113+
88'`88'`88 88' `88 88 88' `88
114+
88 88 88 88. .88 88 88 88
115+
dP dP dP `88888P8 dP dP dP
116+
'''
117+
118+
def main():
119+
x = 20
120+
121+
```
122+
123+
## License & Copyright
124+
125+
Copyright 2023-2024 PySimpleSoft, Inc. and/or its licensors.
126+
127+
This is a free-to-use "Utility" and is licensed under the
128+
PySimpleGUI License Agreement, a copy of which is included in the
129+
license.txt file and also available at https://pysimplegui.com/eula.
130+
131+
Please see Section 1.2 of the license regarding the use of this Utility,
132+
and see https://pysimplegui.com/faq for any questions.
133+
134+
135+
## Contributing
136+
137+
We are happy to receive issues describing bug reports and feature
138+
requests! If your bug report relates to a security vulnerability,
139+
please do not file a public issue, and please instead reach out to us
140+
at issues@PySimpleGUI.com.
141+
142+
We do not accept (and do not wish to receive) contributions of
143+
user-created or third-party code, including patches, pull requests, or
144+
code snippets incorporated into submitted issues. Please do not send
145+
us any such code! Bug reports and feature requests should not include
146+
any source code.
147+
148+
If you nonetheless submit any user-created or third-party code to us,
149+
(1) you assign to us all rights and title in or relating to the code;
150+
and (2) to the extent any such assignment is not fully effective, you
151+
hereby grant to us a royalty-free, perpetual, irrevocable, worldwide,
152+
unlimited, sublicensable, transferrable license under all intellectual
153+
property rights embodied therein or relating thereto, to exploit the
154+
code in any manner we choose, including to incorporate the code into
155+
PySimpleGUI and to redistribute it under any terms at our discretion.

0 commit comments

Comments
 (0)