splashscreen-engine 2.0.1__tar.gz → 2.0.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: splashscreen-engine
3
- Version: 2.0.1
3
+ Version: 2.0.3
4
4
  Summary: A module for making Splash Screens with videos, images, loading bars, text rendering, and threaded rendering support for Applications.
5
5
  Home-page: https://github.com/NamanChhabra21/splashscreen-engine
6
6
  Author: Naman Chhabra
@@ -8,7 +8,7 @@ License: MIT
8
8
  Project-URL: Source, https://github.com/NamanChhabra21/splashscreen-engine
9
9
  Project-URL: Issues, https://github.com/NamanChhabra21/splashscreen-engine/issues
10
10
  Project-URL: Discussions, https://github.com/NamanChhabra21/splashscreen-engine/discussions
11
- Keywords: pygame,splash-screen,loading-screen,python,gui,video,splashscreen,pygame-gui,window,animation,loading,open-cv,naman,chhabra,splash,pypi,github,screen,how to,module,api,example,documentation,README,tkinter,customtkinter,opencv-python,code,2.0.1,player,tutorial
11
+ Keywords: pygame,splash-screen,loading-screen,python,gui,video,splashscreen,pygame-gui,window,animation,loading,open-cv,naman,chhabra,splash,pypi,github,screen,how to,module,api,example,documentation,README,tkinter,customtkinter,opencv-python,code,2.0.3,player,tutorial
12
12
  Classifier: Programming Language :: Python :: 3
13
13
  Classifier: License :: OSI Approved :: MIT License
14
14
  Classifier: Operating System :: OS Independent
@@ -59,7 +59,7 @@ pip install splashscreen-engine
59
59
  ```
60
60
  OR
61
61
  ```bash
62
- pip install splashscreen-engine==2.0.1
62
+ pip install splashscreen-engine==2.0.3
63
63
  ```
64
64
 
65
65
  ## Example
@@ -133,7 +133,7 @@ instead of `screen.stop()`
133
133
 
134
134
  # Main Screen Example
135
135
 
136
- import tkinter # pip install tkinter -- used as main screen for example.
136
+ import tkinter # Used as main screen for example.
137
137
  main_screen = tkinter.Tk()
138
138
 
139
139
  main_screen.geometry("750x500")
@@ -235,6 +235,10 @@ It usually contains:
235
235
  screen = splash.Screen(title_bar=True)
236
236
  ```
237
237
  #### Functions for Title Bar
238
+ ##### Adding an Icon
239
+ ```python
240
+ screen.set_icon("YourIcon.png")
241
+ ```
238
242
  ##### To Check if the user clicked on `X` button
239
243
  ```python
240
244
  screen.is_quit()
@@ -498,19 +502,31 @@ text = splash.Text(
498
502
  )
499
503
  ```
500
504
 
501
- This places the text:
502
- - Horizontally centered
503
- - 100 pixels above the center
504
-
505
505
  ---
506
-
506
+ ### Getting Documentation
507
+ ```python
508
+ documentation = splash.Documentation()
509
+ ```
510
+ #### Opening Documentation
511
+ This opens `README.md` file on Github
512
+ ```python
513
+ documentation.open()
514
+ ```
515
+ #### Contact Details
516
+ This prints all the contact details
517
+ ```python
518
+ documentation.contact()
519
+ ```
520
+ ---
507
521
  ## Contributing & Feedback
508
522
 
509
523
  Discuss approaches, suggest new features,
510
524
  report bugs, or share improvements through GitHub
511
525
  issues and discussions.
512
526
 
513
- Mail:
527
+ ##### Mail:
514
528
  chhabranaman21@gmail.com
529
+ ##### PyPI:
530
+ https://pypi.org/project/splashscreen-engine
515
531
 
516
532
  ---
@@ -25,7 +25,7 @@ pip install splashscreen-engine
25
25
  ```
26
26
  OR
27
27
  ```bash
28
- pip install splashscreen-engine==2.0.1
28
+ pip install splashscreen-engine==2.0.3
29
29
  ```
30
30
 
31
31
  ## Example
@@ -99,7 +99,7 @@ instead of `screen.stop()`
99
99
 
100
100
  # Main Screen Example
101
101
 
102
- import tkinter # pip install tkinter -- used as main screen for example.
102
+ import tkinter # Used as main screen for example.
103
103
  main_screen = tkinter.Tk()
104
104
 
105
105
  main_screen.geometry("750x500")
@@ -201,6 +201,10 @@ It usually contains:
201
201
  screen = splash.Screen(title_bar=True)
202
202
  ```
203
203
  #### Functions for Title Bar
204
+ ##### Adding an Icon
205
+ ```python
206
+ screen.set_icon("YourIcon.png")
207
+ ```
204
208
  ##### To Check if the user clicked on `X` button
205
209
  ```python
206
210
  screen.is_quit()
@@ -464,19 +468,31 @@ text = splash.Text(
464
468
  )
465
469
  ```
466
470
 
467
- This places the text:
468
- - Horizontally centered
469
- - 100 pixels above the center
470
-
471
471
  ---
472
-
472
+ ### Getting Documentation
473
+ ```python
474
+ documentation = splash.Documentation()
475
+ ```
476
+ #### Opening Documentation
477
+ This opens `README.md` file on Github
478
+ ```python
479
+ documentation.open()
480
+ ```
481
+ #### Contact Details
482
+ This prints all the contact details
483
+ ```python
484
+ documentation.contact()
485
+ ```
486
+ ---
473
487
  ## Contributing & Feedback
474
488
 
475
489
  Discuss approaches, suggest new features,
476
490
  report bugs, or share improvements through GitHub
477
491
  issues and discussions.
478
492
 
479
- Mail:
493
+ ##### Mail:
480
494
  chhabranaman21@gmail.com
495
+ ##### PyPI:
496
+ https://pypi.org/project/splashscreen-engine
481
497
 
482
498
  ---
@@ -6,7 +6,7 @@ with open("README.md", "r", encoding="utf-8") as f:
6
6
  setup(
7
7
  name="splashscreen-engine",
8
8
 
9
- version="2.0.1",
9
+ version="2.0.3",
10
10
 
11
11
  py_modules=["splashscreen_engine"],
12
12
 
@@ -63,7 +63,7 @@ setup(
63
63
  "customtkinter",
64
64
  "opencv-python",
65
65
  "code",
66
- "2.0.1",
66
+ "2.0.3",
67
67
  "player",
68
68
  "tutorial"
69
69
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: splashscreen-engine
3
- Version: 2.0.1
3
+ Version: 2.0.3
4
4
  Summary: A module for making Splash Screens with videos, images, loading bars, text rendering, and threaded rendering support for Applications.
5
5
  Home-page: https://github.com/NamanChhabra21/splashscreen-engine
6
6
  Author: Naman Chhabra
@@ -8,7 +8,7 @@ License: MIT
8
8
  Project-URL: Source, https://github.com/NamanChhabra21/splashscreen-engine
9
9
  Project-URL: Issues, https://github.com/NamanChhabra21/splashscreen-engine/issues
10
10
  Project-URL: Discussions, https://github.com/NamanChhabra21/splashscreen-engine/discussions
11
- Keywords: pygame,splash-screen,loading-screen,python,gui,video,splashscreen,pygame-gui,window,animation,loading,open-cv,naman,chhabra,splash,pypi,github,screen,how to,module,api,example,documentation,README,tkinter,customtkinter,opencv-python,code,2.0.1,player,tutorial
11
+ Keywords: pygame,splash-screen,loading-screen,python,gui,video,splashscreen,pygame-gui,window,animation,loading,open-cv,naman,chhabra,splash,pypi,github,screen,how to,module,api,example,documentation,README,tkinter,customtkinter,opencv-python,code,2.0.3,player,tutorial
12
12
  Classifier: Programming Language :: Python :: 3
13
13
  Classifier: License :: OSI Approved :: MIT License
14
14
  Classifier: Operating System :: OS Independent
@@ -59,7 +59,7 @@ pip install splashscreen-engine
59
59
  ```
60
60
  OR
61
61
  ```bash
62
- pip install splashscreen-engine==2.0.1
62
+ pip install splashscreen-engine==2.0.3
63
63
  ```
64
64
 
65
65
  ## Example
@@ -133,7 +133,7 @@ instead of `screen.stop()`
133
133
 
134
134
  # Main Screen Example
135
135
 
136
- import tkinter # pip install tkinter -- used as main screen for example.
136
+ import tkinter # Used as main screen for example.
137
137
  main_screen = tkinter.Tk()
138
138
 
139
139
  main_screen.geometry("750x500")
@@ -235,6 +235,10 @@ It usually contains:
235
235
  screen = splash.Screen(title_bar=True)
236
236
  ```
237
237
  #### Functions for Title Bar
238
+ ##### Adding an Icon
239
+ ```python
240
+ screen.set_icon("YourIcon.png")
241
+ ```
238
242
  ##### To Check if the user clicked on `X` button
239
243
  ```python
240
244
  screen.is_quit()
@@ -498,19 +502,31 @@ text = splash.Text(
498
502
  )
499
503
  ```
500
504
 
501
- This places the text:
502
- - Horizontally centered
503
- - 100 pixels above the center
504
-
505
505
  ---
506
-
506
+ ### Getting Documentation
507
+ ```python
508
+ documentation = splash.Documentation()
509
+ ```
510
+ #### Opening Documentation
511
+ This opens `README.md` file on Github
512
+ ```python
513
+ documentation.open()
514
+ ```
515
+ #### Contact Details
516
+ This prints all the contact details
517
+ ```python
518
+ documentation.contact()
519
+ ```
520
+ ---
507
521
  ## Contributing & Feedback
508
522
 
509
523
  Discuss approaches, suggest new features,
510
524
  report bugs, or share improvements through GitHub
511
525
  issues and discussions.
512
526
 
513
- Mail:
527
+ ##### Mail:
514
528
  chhabranaman21@gmail.com
529
+ ##### PyPI:
530
+ https://pypi.org/project/splashscreen-engine
515
531
 
516
532
  ---
@@ -155,6 +155,10 @@ class Screen:
155
155
  # FOREGROUND VIDEO
156
156
  self.foreground_video = None
157
157
 
158
+ # Icon
159
+ self.icon = pygame.image.load("SplashLogo.png")
160
+
161
+
158
162
  # GLOBAL UI
159
163
  self.ui_elements = []
160
164
 
@@ -163,6 +167,10 @@ class Screen:
163
167
 
164
168
 
165
169
 
170
+
171
+
172
+
173
+
166
174
  def get_size(self):
167
175
  return self.width,self.height
168
176
 
@@ -187,11 +195,12 @@ class Screen:
187
195
  # Creates window with title Bar
188
196
  self.screen = pygame.display.set_mode((w, h),pygame.RESIZABLE)
189
197
 
190
-
198
+ pygame.display.set_icon(self.icon.convert_alpha())
191
199
  self.screen.fill(self.bgColor)
192
200
 
193
201
  pygame.display.update()
194
202
 
203
+
195
204
  # BACKGROUND MAINLOOP
196
205
  def mainloop():
197
206
  global program_stopped
@@ -201,6 +210,8 @@ class Screen:
201
210
 
202
211
  self.running = True
203
212
 
213
+
214
+
204
215
  while self.running and not self.stopped:
205
216
 
206
217
  # Updates window size every time you resize
@@ -350,6 +361,14 @@ class Screen:
350
361
 
351
362
  self.bgColor = color
352
363
 
364
+ def set_icon(self,path):
365
+ if not self.title_bar:
366
+ raise RuntimeError("Unable to set Icon, Title Bar is disabled.")
367
+ self.icon = path
368
+ icon_image = pygame.image.load(path).convert_alpha()
369
+ pygame.display.set_icon(icon_image)
370
+
371
+
353
372
 
354
373
  def is_quit(self):
355
374
  if not self.title_bar:
@@ -724,3 +743,24 @@ class Text:
724
743
  def show(self):
725
744
  self.visible = True
726
745
 
746
+ class Documentation:
747
+ def __init__(self):
748
+ self.GithubReadMeLink = "https://github.com/NamanChhabra21/splashscreen-engine/blob/main/README.md"
749
+ self.gmail = "chhabranaman21@gmail.com"
750
+ self.ytChannel = "www.youtube.com/@GenZCoderZShorts"
751
+ self.GithubLink = "https://github.com/NamanChhabra21"
752
+ self.pypi = "https://pypi.org/project/splashscreen-engine/"
753
+ self.issues = "https://github.com//NamanChhabra21//splashscreen-engine//issues"
754
+ self.discussions = "https://github.com/NamanChhabra21/splashscreen-engine/discussions"
755
+
756
+ def open(self):
757
+ os.startfile(self.GithubReadMeLink)
758
+ def contact(self):
759
+ print(f"For Contact & Feedback :\n\
760
+ Github : {self.GithubLink}\n\
761
+ PyPI : {self.pypi}\n\
762
+ YouTube : {self.ytChannel}\n\
763
+ Issues : {self.issues}\n\
764
+ Discussions : {self.discussions}\n\
765
+ Mail : {self.gmail}")
766
+