Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/panos-stavrianos/flet_timer
Flet Timer is a timer component for the Flet framework that enables the creation of countdown timers with real-time display updates, providing a seamless integration with Flet applications.
https://github.com/panos-stavrianos/flet_timer
component flet flet-dev gui python timer
Last synced: about 1 month ago
JSON representation
Flet Timer is a timer component for the Flet framework that enables the creation of countdown timers with real-time display updates, providing a seamless integration with Flet applications.
- Host: GitHub
- URL: https://github.com/panos-stavrianos/flet_timer
- Owner: panos-stavrianos
- License: mit
- Created: 2023-07-06T12:00:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-07T11:07:06.000Z (over 1 year ago)
- Last Synced: 2024-04-24T19:48:30.825Z (10 months ago)
- Topics: component, flet, flet-dev, gui, python, timer
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flet Timer
[](https://pypi.org/project/flet-timer/)
[](https://opensource.org/licenses/MIT)
The Flet Timer is a timer component for the Flet framework that is based
on the last example from the [Flet User Controls guide](https://flet.dev/docs/guides/python/user-controls/).
It demonstrates how to create a countdown timer using threading for real-time display updates.
## Installation
To use the Flet Timer, you can install it using pip:
```
pip install flet-timer
```
## Usage
Here's an example that demonstrates how to use the Flet Timer.
First, let's define a callback function that will execute at a specified interval:
```python
def refresh():
txt_time.value = datetime.now().strftime("%H:%M:%S")
page.update()
```
Next, create the Timer object with the desired interval in seconds, a name, and the callback:
```python
timer = Timer(name="timer", interval_s=1, callback=refresh)
```
Finally, add the Timer component to the page:
```python
page.add(timer)
```
The complete example code would look like this:
```python
from datetime import datetime
import flet as ft
from flet_timer.flet_timer import Timer
def main(page: ft.Page):
page.title = "Flet Timer example"
page.vertical_alignment = ft.MainAxisAlignment.CENTER
page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
txt_time = ft.Text(value="None")
def refresh():
txt_time.value = datetime.now().strftime("%H:%M:%S")
page.update()
timer = Timer(name="timer", interval_s=1, callback=refresh)
page.add(
timer,
txt_time
)
ft.app(main)
```
In this example, we create a Flet application that displays the current time using the `Text` component. We define
a `refresh()` function that updates the `txt_time` value with the current time and triggers a page update. We
instantiate a `Timer` with a 1-second interval and the `refresh()` function as the callback. The timer continuously
calls the callback, updating the UI with the current time.
Certainly! Here's the disclaimer in markdown format:
## Disclaimer
Please note that this package is provided as-is and has not been extensively tested.
While the provided functionality should work in most situations,
there is a possibility of unforeseen issues or compatibility conflicts.
It is recommended to thoroughly test the package and adapt it to your specific use case before deploying it in a
production environment.
## Contributing
Contributions to the Flet Timer project are welcome! If you find any issues or have suggestions for improvements, please
open an issue or submit a pull request on the [GitHub repository](https://github.com/panos-stavrianos/flet_timer).
## License
The Flet Timer is open-source software released under the [MIT License](https://opensource.org/licenses/MIT). See
the [LICENSE](https://github.com/example/flet-timer/blob/main/LICENSE) file for more information.