CTkLoadingPopup 1.0.0__py3-none-any.whl

CTkLoadingPopup/__init__.py

@@ -0,0 +1,6 @@
+"""
+Author: limafresh
+Homepage: https://github.com/limafresh/CTkLoadingPopup
+"""
+
+from .ctk_loading_popup import CTkLoadingPopup

CTkLoadingPopup/ctk_loading_popup.py

@@ -0,0 +1,182 @@
+import customtkinter
+
+class CTkLoadingPopup(customtkinter.CTkFrame):
+    def __init__(
+        self,
+        parent,
+        text: str="Loading...",
+        progress: float=0.0,
+        start_angle: int=90,
+        indeterminate_speed: int=10,
+        spinner_size: int=50,
+        spinner_width: int=4,
+        corner_radius: int=15,
+        border_width: int=2,
+        border_color=None,
+        font=None,
+        bg_color=("gray28", "gray21"),
+        text_color="gray99",
+        spinner_color=None,
+        progress_color=None,
+        mode: str="indeterminate",
+        padx: int=20,
+        pady: int=30,
+        cancel_button: bool=False,
+        cancel_button_text: str="Cancel",
+        cancel_button_text_color="white",
+        cancel_button_hover_color=("gray39", "gray33"),
+        cancel_button_state: str="normal",
+        compound: str="left",
+        close_command=None,
+    ):
+        super().__init__(parent, border_width=border_width, border_color=border_color,
+                         corner_radius=corner_radius, fg_color=bg_color)
+        self.place(relx=0.5, rely=0.5, anchor=customtkinter.CENTER)
+
+        self.progress = progress
+        self.angle = start_angle
+        self.indeterminate_speed = indeterminate_speed
+        self.spinner_size = spinner_size
+        self.spinner_width = spinner_width
+        self.bg_color = bg_color
+        self.spinner_color = spinner_color if spinner_color else customtkinter.ThemeManager.theme["CTkProgressBar"]["fg_color"]
+        self.progress_color = progress_color if progress_color else customtkinter.ThemeManager.theme["CTkProgressBar"]["progress_color"]
+        self.mode = mode
+        self.close_command = close_command
+
+        self.is_stop = False
+
+        frame = customtkinter.CTkFrame(self, fg_color="transparent")
+        frame.pack(padx=padx, pady=pady)
+
+        self.canvas = customtkinter.CTkCanvas(frame, width=spinner_size, height=spinner_size, highlightthickness=0)
+
+        self.label = customtkinter.CTkLabel(frame, text=text, font=font, text_color=text_color,
+                                            width=150)
+
+        if compound == "left":
+            self.canvas.pack(side=customtkinter.LEFT)
+            self.label.configure(anchor=customtkinter.W)
+            self.label.pack(side=customtkinter.LEFT, padx=(padx, 0))
+        elif compound == "right":
+            self.label.configure(anchor=customtkinter.W)
+            self.label.pack(side=customtkinter.LEFT)
+            self.canvas.pack(side=customtkinter.LEFT, padx=(padx, 0))
+        elif compound == "top":
+            self.label.pack()
+            self.canvas.pack(pady=(pady, 0))
+
+        if cancel_button:
+            self.cancel_button = customtkinter.CTkButton(
+                self,
+                fg_color=self.bg_color,
+                text_color=cancel_button_text_color,
+                hover_color=cancel_button_hover_color,
+                text=cancel_button_text.upper(),
+                width=0,
+                height=35,
+                state=cancel_button_state,
+                corner_radius=20,
+                cursor="hand2",
+                command=self.close,
+            )
+            self.cancel_button.pack(padx=(0, 10), pady=(0, 10), anchor=customtkinter.E)
+        else:
+            self.cancel_button = None
+
+        self.animate()
+
+    def animate(self):
+        self.canvas.delete("all")
+
+        if customtkinter.get_appearance_mode() == "Light":
+            theme_index = 0
+        else:
+            theme_index = 1
+        bg_color, spinner_color, progress_color = self.bg_color, self.spinner_color, self.progress_color
+        if isinstance(self.bg_color, (list, tuple)):
+            bg_color = self.bg_color[theme_index]
+        if isinstance(self.spinner_color, (list, tuple)):
+            spinner_color = self.spinner_color[theme_index]
+        if isinstance(self.progress_color, (list, tuple)):
+            progress_color = self.progress_color[theme_index]
+        self.canvas.configure(background=bg_color)
+
+        scaling = customtkinter.ScalingTracker.widget_scaling
+        spinner_size = int(self.spinner_size * scaling)
+        spinner_width = int(self.spinner_width * scaling)
+        if self.canvas.winfo_width() != spinner_size:
+            self.canvas.configure(width=spinner_size, height=spinner_size)
+
+        center = spinner_size // 2
+
+        # Draw anti-aliased circle using CustomTkinter method
+
+        # outline
+        self.canvas.create_aa_circle(
+            center, center,
+            center,
+            fill=spinner_color
+        )
+
+        # fill
+        self.canvas.create_aa_circle(
+            center, center,
+            center - spinner_width,
+            fill=bg_color
+        )
+
+        if self.mode == "indeterminate":
+            extent = -90
+        elif self.mode == "determinate":
+            extent = -self.progress * 360
+        else:
+            print(f"Invalid mode: {self.mode}. Please use 'indeterminate' or 'determinate'")
+            return
+
+        start = spinner_width // 2
+
+        self.canvas.create_arc(
+            start, start,
+            spinner_size - start,
+            spinner_size - start,
+            start=self.angle,
+            extent=extent,
+            outline=progress_color,
+            style="arc",
+            width=spinner_width,
+        )
+
+        if self.mode == "indeterminate":
+            self.angle = (self.angle - self.indeterminate_speed) % 360
+
+        if not self.is_stop:
+            self.after(50, self.animate)
+
+    def configure(self, text: str=None, progress: float=None, progress_color=None,
+                  cancel_button_state: str=None):
+        if text:
+            self.label.configure(text=text)
+        if progress is not None:
+            self.progress = progress
+        if progress_color:
+            self.progress_color = progress_color
+        if cancel_button_state and self.cancel_button:
+            self.cancel_button.configure(state=cancel_button_state)
+
+    def close(self):
+        if self.close_command:
+            self.close_command()
+
+        self.destroy()
+
+    def stop(self, value: bool):
+        self.is_stop = value
+        if not self.is_stop:
+            self.animate()
+
+    def get(self):
+        if self.mode == "determinate":
+            return self.progress
+        else:
+            return None

ctkloadingpopup-1.0.0.dist-info/METADATA

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: CTkLoadingPopup
+Version: 1.0.0
+Summary: A modern loading popup widget for Python CustomTkinter
+Author: limafresh
+Maintainer: limafresh
+License-Expression: CC0-1.0
+Project-URL: Homepage, https://github.com/limafresh/CTkLoadingPopup
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: customtkinter
+Dynamic: license-file
+
+# CTkLoadingPopup
+
+![Static Badge](https://img.shields.io/badge/Scaling-friendly-blue?style=for-the-badge)
+
+A modern loading popup widget for Python CustomTkinter.
+
+![screenshot](https://raw.githubusercontent.com/limafresh/CTkLoadingPopup/main/screenshot.png)
+
+```python
+import customtkinter
+from CTkLoadingPopup import CTkLoadingPopup
+
+app = customtkinter.CTk()
+app.geometry("400x400")
+CTkLoadingPopup(app)
+app.mainloop()
+```
+
+## Usage
+
+### Using pip
+
+```
+pip install git+https://github.com/limafresh/CTkLoadingPopup.git
+```
+
+### Without installation
+
+Simply download the `CTkLoadingPopup` folder and place it in your script directory.
+
+## Arguments
+
+| **Parameter** | **Description** |
+|-|-|
+| **parent** | root or toplevel, required |
+| text | popup text |
+| progress | *float*, from 0.0 to 1.0 |
+| start_angle | initial angle of the spinner |
+| indeterminate_speed | speed of the spinning in the indeterminate mode |
+| spinner_size | size of the spinner |
+| spinner_width | width of the spinner outline |
+| corner_radius | corner radius of popup |
+| border_width | border width of popup |
+| border_color | border color of popup |
+| font | font of popup text |
+| bg_color | popup background color |
+| text_color | text color |
+| spinner_color | spinner color |
+| progress_color | spinner progress color |
+| mode | `"indeterminate"` (by default) or `"determinate"` |
+| padx | set horizontal padding |
+| pady | set vertical padding |
+| cancel_button | add a "Cancel" button that closes the popup |
+| cancel_button_text | text of cancel button |
+| cancel_button_text_color | text color of cancel button |
+| cancel_button_hover_color | hover color of cancel button |
+| cancel_button_state | cancel button state (see CTkButton documentation) |
+| compound | `"left"` (by default), `"right"`, `"top"` |
+| close_command | command that is executed before closing |
+
+## Methods
+
+- **.configure(*args)**: change some popup options
+- **.close()**
+- **.stop(value)**: `True` or `False`
+- **.get()**: returns progress value (in determinate mode) or None (in indeterminate mode)

ctkloadingpopup-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+CTkLoadingPopup/__init__.py,sha256=b8Hf4GrnrFWknU_uBkJfQ5-TrFSu_VTvxIEY_aYg-ak,135
+CTkLoadingPopup/ctk_loading_popup.py,sha256=8y_Bvd5kdCj-TjPKm8HFUjL6xX8TConivg6GQWgyRvM,6499
+ctkloadingpopup-1.0.0.dist-info/licenses/LICENSE,sha256=9Ofzc7m5lpUDN-jUGkopOcLZC3cl6brz1QhKInF60yg,7169
+ctkloadingpopup-1.0.0.dist-info/METADATA,sha256=6ekjU4E8eE3BpNPOEtWeG_LMc394G1ewl_F7t2sLh9I,2519
+ctkloadingpopup-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ctkloadingpopup-1.0.0.dist-info/top_level.txt,sha256=K8BfPnjb5XRktyrkQ9_2C8WVeA8QFPEegmCGCM5KC0c,16
+ctkloadingpopup-1.0.0.dist-info/RECORD,,

ctkloadingpopup-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ctkloadingpopup-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

ctkloadingpopup-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+CTkLoadingPopup