pygets 1.0.0__tar.gz

pygets-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ZentarDev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pygets-1.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+recursive-include pygets *.py
+recursive-include docs *.md
+global-exclude __pycache__
+global-exclude *.py[cod]

pygets-1.0.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: pygets
+Version: 1.0.0
+Summary: GUI widgets toolkit for pygame
+Author: ZentarDev
+License-Expression: MIT
+Keywords: pygame,gui,widgets,ui,game-dev
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygame
+Requires-Dist: pyperclip
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: twine>=5.1.0; extra == "dev"
+Dynamic: license-file
+
+# PyGets
+
+PyGets is a lightweight widget toolkit for building small interfaces with `pygame`.
+
+It provides reusable UI components for rapid prototypes, tools, menus, and simple applications without introducing a larger GUI framework.
+
+## Features
+
+- `Button`
+- `Checkbox`
+- `Combobox`
+- `Popup`
+- `Slider`
+- `Textbox`
+- `Togglebutton`
+- Built-in theme system with multiple predefined themes
+
+## Installation
+
+After publishing to PyPI, users can install PyGets with:
+
+```bash
+pip install pygets
+```
+
+For local development from this repository:
+
+```bash
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+import pygame
+
+from pygets.core.theme import themes
+from pygets.widgets import Button
+
+pygame.init()
+
+screen = pygame.display.set_mode((800, 500))
+pygame.display.set_caption("PyGets Demo")
+
+font = pygame.font.Font(None, 28)
+button = Button(
+    x=80,
+    y=80,
+    font=font,
+    screen=screen,
+    theme=themes["light"],
+    text="Click me",
+)
+
+clock = pygame.time.Clock()
+running = True
+
+while running:
+    clock.tick(60)
+
+    for event in pygame.event.get():
+        if event.type == pygame.QUIT:
+            running = False
+        if event.type == pygame.MOUSEBUTTONDOWN and event.button == 1:
+            if button.rect.collidepoint(event.pos):
+                print("Button pressed")
+
+    screen.fill((96, 140, 168))
+    button.draw()
+    pygame.display.flip()
+
+pygame.quit()
+```
+
+## Development
+
+Install development dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+Run the test suite:
+
+```bash
+pytest tests
+```
+
+Build release artifacts:
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+## Documentation
+
+- User docs: `docs/`
+- Examples: `examples/`
+- Contribution guide: `docs/CONTRIBUTING.md`
+- Release guide: `RELEASING.md`
+
+## License
+
+PyGets is distributed under the MIT License. See `LICENSE`.

pygets-1.0.0/README.md

@@ -0,0 +1,105 @@
+# PyGets
+
+PyGets is a lightweight widget toolkit for building small interfaces with `pygame`.
+
+It provides reusable UI components for rapid prototypes, tools, menus, and simple applications without introducing a larger GUI framework.
+
+## Features
+
+- `Button`
+- `Checkbox`
+- `Combobox`
+- `Popup`
+- `Slider`
+- `Textbox`
+- `Togglebutton`
+- Built-in theme system with multiple predefined themes
+
+## Installation
+
+After publishing to PyPI, users can install PyGets with:
+
+```bash
+pip install pygets
+```
+
+For local development from this repository:
+
+```bash
+pip install -e .[dev]
+```
+
+## Quick Start
+
+```python
+import pygame
+
+from pygets.core.theme import themes
+from pygets.widgets import Button
+
+pygame.init()
+
+screen = pygame.display.set_mode((800, 500))
+pygame.display.set_caption("PyGets Demo")
+
+font = pygame.font.Font(None, 28)
+button = Button(
+    x=80,
+    y=80,
+    font=font,
+    screen=screen,
+    theme=themes["light"],
+    text="Click me",
+)
+
+clock = pygame.time.Clock()
+running = True
+
+while running:
+    clock.tick(60)
+
+    for event in pygame.event.get():
+        if event.type == pygame.QUIT:
+            running = False
+        if event.type == pygame.MOUSEBUTTONDOWN and event.button == 1:
+            if button.rect.collidepoint(event.pos):
+                print("Button pressed")
+
+    screen.fill((96, 140, 168))
+    button.draw()
+    pygame.display.flip()
+
+pygame.quit()
+```
+
+## Development
+
+Install development dependencies:
+
+```bash
+pip install -e .[dev]
+```
+
+Run the test suite:
+
+```bash
+pytest tests
+```
+
+Build release artifacts:
+
+```bash
+python -m build
+python -m twine check dist/*
+```
+
+## Documentation
+
+- User docs: `docs/`
+- Examples: `examples/`
+- Contribution guide: `docs/CONTRIBUTING.md`
+- Release guide: `RELEASING.md`
+
+## License
+
+PyGets is distributed under the MIT License. See `LICENSE`.

pygets-1.0.0/docs/CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to Pygets
+
+Thank you for your interest in contributing to Pygets! This document provides guidelines and information to help you get started.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Coding Standards](#coding-standards)
+- [Testing](#testing)
+- [Submitting Changes](#submitting-changes)
+- [Reporting Issues](#reporting-issues)
+
+## Getting Started
+
+Pygets is a Python library for creating GUI widgets. Contributions are welcome in the form of bug fixes, new features, documentation improvements, or tests.
+
+Before contributing, please:
+
+1. Fork the repository on GitHub.
+2. Clone your fork locally.
+3. Create a new branch for your changes.
+
+## Development Setup
+
+To set up a development environment:
+
+1. Ensure you have Python 3.10+ installed.
+2. Install the project in editable mode with development tools:
+   ```bash
+   pip install -e .[dev]
+   ```
+3. Run the test suite before opening a pull request.
+
+The project structure is as follows:
+
+- `pygets/`: Main source code
+  - `core/`: Core functionality (theme.py, widgets.py)
+  - `utils/`: Utilities (colors.py, validators.py)
+  - `widgets/`: Widget implementations (button.py, checkbox.py, etc.)
+- `tests/`: Unit tests for each widget (test_button.py, test_checkbox.py, etc.)
+
+## Coding Standards
+
+- Follow PEP 8 style guidelines.
+- Use descriptive variable and function names.
+- Add docstrings to all public functions and classes.
+- Keep lines under 80 characters where possible.
+
+## Testing
+
+Pygets uses pytest for testing. To run tests:
+
+```bash
+pytest tests
+```
+
+Ensure all tests pass before submitting changes. Add tests for new features or bug fixes.
+
+## Submitting Changes
+
+1. Commit your changes with clear, descriptive messages.
+2. Push to your fork.
+3. Create a pull request on GitHub.
+4. Describe the changes and reference any related issues.
+
+## Reporting Issues
+
+If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce.
+
+We appreciate your contributions!

pygets-1.0.0/docs/customization.md

@@ -0,0 +1,240 @@
+# Customization
+
+PyGets customization is centered around `Theme` objects plus a few widget-level sizing and layout parameters.
+
+## Theme model
+
+Each theme defines five color roles:
+
+- `background`
+- `foreground`
+- `accent`
+- `idle`
+- `text`
+
+The `Theme` class is available from `pygets.core.theme`.
+
+```python
+from pygets.core.theme import Theme
+
+custom_theme = Theme(
+    name="custom",
+    background=(28, 28, 32),
+    foreground=(240, 240, 240),
+    accent=(80, 180, 255),
+    idle=(110, 110, 120),
+    text=(255, 255, 255),
+)
+```
+
+## Built-in themes
+
+PyGets ships with these predefined themes in `pygets.core.theme.themes`:
+
+- `light`
+- `dark`
+- `forest`
+- `ocean`
+- `sunset`
+- `purple_night`
+- `silver`
+
+Example:
+
+```python
+from pygets.core.theme import themes
+
+theme = themes["forest"]
+```
+
+## Built-in color palette
+
+If you prefer named RGB values instead of hardcoding tuples, use `pygets.utils.colors.colors`.
+
+Examples available in the palette include:
+
+- `WHITE`, `BLACK`, `GRAY`, `DARK_GRAY`
+- `BLUE`, `LIGHT_BLUE`, `TURQUOISE`
+- `GREEN`, `LIGHT_GREEN`, `MINT_GREEN`, `OLIVE`
+- `DARK_ORANGE`, `GOLD`, `PURPLE`, `LAVENDER`
+- `SAND`, `SILVER`, `BLUISH_GRAY`
+
+```python
+from pygets.core.theme import Theme
+from pygets.utils.colors import colors
+
+theme = Theme(
+    name="studio",
+    background=colors["BLACK"],
+    foreground=colors["WHITE"],
+    accent=colors["TURQUOISE"],
+    idle=colors["DARK_GRAY"],
+    text=colors["WHITE"],
+)
+```
+
+## Widget-level customization
+
+### Button
+
+Useful parameters:
+
+- `width` and `height` to override auto sizing
+- `image` to add an icon
+- `text` to show a label
+- `edges` to enable or disable the border
+- `border_radius` for corner roundness
+- `spacing` for image/text separation
+
+```python
+button = Button(
+    x=40,
+    y=40,
+    font=font,
+    screen=screen,
+    theme=theme,
+    text="Export",
+    width=200,
+    border_radius=24,
+    spacing=12,
+)
+```
+
+### Checkbox
+
+Useful parameters:
+
+- `checked` for the initial state
+- `size` for the box size
+- `border_radius` for square vs rounded corners
+
+```python
+checkbox = Checkbox(
+    x=40,
+    y=120,
+    screen=screen,
+    theme=theme,
+    checked=True,
+    size=24,
+    border_radius=6,
+)
+```
+
+### Combobox
+
+Useful parameters:
+
+- `width` and `height`
+- `options`
+- `border_radius`
+
+```python
+combo = Combobox(
+    x=40,
+    y=180,
+    width=260,
+    height=36,
+    screen=screen,
+    options=["Python", "Rust", "Go"],
+    font=font,
+    theme=theme,
+    border_radius=12,
+)
+```
+
+### Textbox
+
+Useful parameters:
+
+- `placeholder`
+- `width`
+- `max_characters`
+- `border_radius`
+- `function` callback when Enter is pressed
+
+```python
+textbox = Textbox(
+    x=40,
+    y=250,
+    screen=screen,
+    font=font,
+    theme=theme,
+    placeholder="Write your email...",
+    width=360,
+    max_characters=120,
+    border_radius=14,
+)
+```
+
+### Slider
+
+Useful parameters:
+
+- `width` and `height`
+- `min_val`
+- `max_val`
+- `initial_value`
+
+```python
+slider = Slider(
+    x=40,
+    y=330,
+    width=300,
+    height=8,
+    screen=screen,
+    theme=theme,
+    min_val=0,
+    max_val=1,
+    initial_value=0.5,
+)
+```
+
+### Togglebutton
+
+Useful parameters:
+
+- `width` and `height`
+- `active`
+
+```python
+toggle = Togglebutton(
+    x=40,
+    y=390,
+    screen=screen,
+    theme=theme,
+    width=72,
+    height=36,
+    active=True,
+)
+```
+
+### Popup
+
+Useful parameters:
+
+- `title` and `message`
+- `width` and `height`
+- `font` and `title_font`
+- `theme`
+
+```python
+popup = Popup(
+    title="Saved",
+    message="Your settings were updated successfully.",
+    font=font,
+    title_font=title_font,
+    screen=screen,
+    screen_width=800,
+    screen_height=600,
+    width=420,
+    height=220,
+    theme=theme,
+)
+```
+
+## Practical guidance
+
+- Use `theme.background` for widget surfaces and a separate window background for contrast.
+- Keep `theme.text` and `theme.foreground` high-contrast, especially for `Textbox` and `Combobox`.
+- Prefer larger `border_radius` values for soft UI and small values for more compact tooling interfaces.
+- When a widget supports hover, `theme.idle` controls the overlay tint that appears on pointer focus.