devjoni-hosguibase


Namedevjoni-hosguibase JSON
Version 0.0.4 PyPI version JSON
download
home_pageNone
SummaryA simplified widget toolkit supporting many backends
upload_time2025-01-28 21:17:50
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords toolkit gui tk gtk p3d
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Hosguibase - A multi-backend GUI toolkit

Hosguibase a toolkit for making graphical user interfaces using Python
Hosguibase uses other toolkits
as its backends, which allow programs to look native on many platforms.
Some backends may have qualities that make them better suited
for certain tasks.

Hosguibase does not aim to expose all or even many
functionalities of its backends. On the contrary, we look for a
minimal feature set that can be used to create acceptable applications.
This minimalism is to ease the workload needed to
maintain multiple backends.
You can use the features of a backend directly but this
will likely lock you down to that specific backend (which may not be
bad at all).

Hosguibase is developed by DEV Joni since 2023. Currently,
the project is in an early stage not recommended
for production.


## Installing

```
pip install devjoni-hosguibase
```

## API Overview

### Widgets

- MainWindow - The main window
- FrameWidget - Containment and partitioning
- TextWidget - Non-editable text (label)
- ButtonWidget - Clickable -> command
- SliderWidget - Slidable (scale)
- EntryWidget - Single-line editable text
- EditorWidget - Multiline editable text
- DropdownWidget - Selection (optionmenu)
- ImageWidget - Shows an image

The API resembles tkinter. When creating a new widget,
you specify its parent and then make the widget appear
on the screen by using the grid method.

### A hello world example

```python
import devjoni.guibase as gb

app = gb.MainWindow()
app.title = "My graphical program"
app.geometry = "small"

hello = gb.TextWidget(app)
hello.grid(row=0, column=0)

hello.set(text='Hello world!')

app.run()
```

## Supported Backends

Default backend: tkinter

- tkinter : The GUI toolkit based on tcl/tk that comes with Python
- gtk3/4 (via gi): A toolkit used for example by GNOME
- p3d : Panda3D - The open-source 3D rendering engine

The backend is currently selected with flags to the program.


### Tkinter backend (default)

Launching

```
python myprogram.py --tk
```

### GTK backends

Requirements

```
pip install PyGObject
```

Launching version 3
```
python myprogram.py --gtk3
```

or version 4

```
python myprogram.py --gtk4
```

### Panda3D backend

Requirements

```
pip install Panda3D
```

Launching

```
python myprogram.py --p3d
```


## Current Limitations

- Only grid layout engine supported (no free placement of widgets)
- Playing videos or 3D graphics not straighforward
- No dedicated touch or joystick support


## Contributing

### Reporting Issues

Please feel free to report any bugs or issues in our bug tracker in Github:

[https://github.com/devjonix/hosguibase/issues](https://github.com/devjonix/hosguibase/issues)

### Pull Requests

Despite commercial backing this is a true open-source project.
We appriciate any inputs to the project as GitHub pull requests.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "devjoni-hosguibase",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "toolkit, GUI, tk, gtk, p3d",
    "author": null,
    "author_email": "DEV Joni <solutions@devjoni.com>",
    "download_url": "https://files.pythonhosted.org/packages/a0/7b/77e0d39d548020849c68cef0ebe2182145040568ef568903ef9a51022896/devjoni_hosguibase-0.0.4.tar.gz",
    "platform": null,
    "description": "# Hosguibase - A multi-backend GUI toolkit\n\nHosguibase a toolkit for making graphical user interfaces using Python\nHosguibase uses other toolkits\nas its backends, which allow programs to look native on many platforms.\nSome backends may have qualities that make them better suited\nfor certain tasks.\n\nHosguibase does not aim to expose all or even many\nfunctionalities of its backends. On the contrary, we look for a\nminimal feature set that can be used to create acceptable applications.\nThis minimalism is to ease the workload needed to\nmaintain multiple backends.\nYou can use the features of a backend directly but this\nwill likely lock you down to that specific backend (which may not be\nbad at all).\n\nHosguibase is developed by DEV Joni since 2023. Currently,\nthe project is in an early stage not recommended\nfor production.\n\n\n## Installing\n\n```\npip install devjoni-hosguibase\n```\n\n## API Overview\n\n### Widgets\n\n- MainWindow - The main window\n- FrameWidget - Containment and partitioning\n- TextWidget - Non-editable text (label)\n- ButtonWidget - Clickable -> command\n- SliderWidget - Slidable (scale)\n- EntryWidget - Single-line editable text\n- EditorWidget - Multiline editable text\n- DropdownWidget - Selection (optionmenu)\n- ImageWidget - Shows an image\n\nThe API resembles tkinter. When creating a new widget,\nyou specify its parent and then make the widget appear\non the screen by using the grid method.\n\n### A hello world example\n\n```python\nimport devjoni.guibase as gb\n\napp = gb.MainWindow()\napp.title = \"My graphical program\"\napp.geometry = \"small\"\n\nhello = gb.TextWidget(app)\nhello.grid(row=0, column=0)\n\nhello.set(text='Hello world!')\n\napp.run()\n```\n\n## Supported Backends\n\nDefault backend: tkinter\n\n- tkinter : The GUI toolkit based on tcl/tk that comes with Python\n- gtk3/4 (via gi): A toolkit used for example by GNOME\n- p3d : Panda3D - The open-source 3D rendering engine\n\nThe backend is currently selected with flags to the program.\n\n\n### Tkinter backend (default)\n\nLaunching\n\n```\npython myprogram.py --tk\n```\n\n### GTK backends\n\nRequirements\n\n```\npip install PyGObject\n```\n\nLaunching version 3\n```\npython myprogram.py --gtk3\n```\n\nor version 4\n\n```\npython myprogram.py --gtk4\n```\n\n### Panda3D backend\n\nRequirements\n\n```\npip install Panda3D\n```\n\nLaunching\n\n```\npython myprogram.py --p3d\n```\n\n\n## Current Limitations\n\n- Only grid layout engine supported (no free placement of widgets)\n- Playing videos or 3D graphics not straighforward\n- No dedicated touch or joystick support\n\n\n## Contributing\n\n### Reporting Issues\n\nPlease feel free to report any bugs or issues in our bug tracker in Github:\n\n[https://github.com/devjonix/hosguibase/issues](https://github.com/devjonix/hosguibase/issues)\n\n### Pull Requests\n\nDespite commercial backing this is a true open-source project.\nWe appriciate any inputs to the project as GitHub pull requests.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simplified widget toolkit supporting many backends",
    "version": "0.0.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/devjonix/hosguibase/issues",
        "Homepage": "https://github.com/devjonix/hosguibase"
    },
    "split_keywords": [
        "toolkit",
        " gui",
        " tk",
        " gtk",
        " p3d"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f3634d042d8264e18e0810e29bece7a09ee9bf51a8b764d1f5d7d27aebfbd86a",
                "md5": "95df662a8393bbf9d705eada1e204dab",
                "sha256": "858685907baed1c231fc1dbb4188563fb49fcc626e51ed2622c32069d6528421"
            },
            "downloads": -1,
            "filename": "devjoni_hosguibase-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "95df662a8393bbf9d705eada1e204dab",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 48576,
            "upload_time": "2025-01-28T21:17:48",
            "upload_time_iso_8601": "2025-01-28T21:17:48.962687Z",
            "url": "https://files.pythonhosted.org/packages/f3/63/4d042d8264e18e0810e29bece7a09ee9bf51a8b764d1f5d7d27aebfbd86a/devjoni_hosguibase-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a07b77e0d39d548020849c68cef0ebe2182145040568ef568903ef9a51022896",
                "md5": "57c6bc9d79955f890c27985c913c9a8f",
                "sha256": "49726a54a63daea5af3249dbef9d52b36225d11d8abdf7a145d809708c5638cf"
            },
            "downloads": -1,
            "filename": "devjoni_hosguibase-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "57c6bc9d79955f890c27985c913c9a8f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 42964,
            "upload_time": "2025-01-28T21:17:50",
            "upload_time_iso_8601": "2025-01-28T21:17:50.986374Z",
            "url": "https://files.pythonhosted.org/packages/a0/7b/77e0d39d548020849c68cef0ebe2182145040568ef568903ef9a51022896/devjoni_hosguibase-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-28 21:17:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "devjonix",
    "github_project": "hosguibase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "devjoni-hosguibase"
}
        
Elapsed time: 1.06304s