Pequena


NamePequena JSON
Version 0.0.58 PyPI version JSON
download
home_page
SummaryLightweight desktop app framework
upload_time2023-05-25 18:45:46
maintainer
docs_urlNone
authorborecjeborec1
requires_python
license
keywords python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pequena
Pequena is a desktop creation framework that allows you to create desktop applications using web technologies such as HTML, CSS, and JavaScript. It is built on top of the [webview](https://pypi.org/project/pywebview/) library for Python.

## NodeJS wrapper
If you can use Node.js, then you should use the [pequena](https://www.npmjs.com/package/pequena) wrapper library, which provides a Node.js API for Pequena.

I personaly advice you to use this if you have node installed. It has built-in scripts for compiling/hot reload/bundling/minimising/etc...

## Installation
Pequena can be installed using pip
```bash
pip install pequena
```

## Usage
To use `Pequena`, first import it:
```python
import Pequena
```

Then call the `init_window` function to set up the client source directory and the window name:
```python
Pequena.init_window("path/to/client/index.html", "Hello World!",width=800, height=600)
```

You can then create a window using the `start_window` function:
```python
Pequena.start_window()
``` 

By default, Pequena uses the `EdgeChromium` backend for webview, but you can also use other backends such as `PyQt5`, `QtWebEngine`, and `Gtk`. But those will require additional installs

You can expose Python functions to your client-side JavaScript code by using the `expose_function` function:
```python
def my_function():
    return "Hello, World!"
Pequena.expose_function(my_function)
``` 

In your client-side JavaScript code, you can then call the Python function using the `PEQUENA` object:
```Javascript
const result = await PEQUENA.my_function();
```

## License
Pequena is licensed under the MIT License.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Pequena",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "python",
    "author": "borecjeborec1",
    "author_email": "<atzuki@protonmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/05/18/7a3981f3593e4ef297215d339449708c19689d1aae9c8fe37626dead45ac/Pequena-0.0.58.tar.gz",
    "platform": null,
    "description": "# Pequena\r\nPequena is a desktop creation framework that allows you to create desktop applications using web technologies such as HTML, CSS, and JavaScript. It is built on top of the [webview](https://pypi.org/project/pywebview/) library for Python.\r\n\r\n## NodeJS wrapper\r\nIf you can use Node.js, then you should use the [pequena](https://www.npmjs.com/package/pequena) wrapper library, which provides a Node.js API for Pequena.\r\n\r\nI personaly advice you to use this if you have node installed. It has built-in scripts for compiling/hot reload/bundling/minimising/etc...\r\n\r\n## Installation\r\nPequena can be installed using pip\r\n```bash\r\npip install pequena\r\n```\r\n\r\n## Usage\r\nTo use `Pequena`, first import it:\r\n```python\r\nimport Pequena\r\n```\r\n\r\nThen call the `init_window` function to set up the client source directory and the window name:\r\n```python\r\nPequena.init_window(\"path/to/client/index.html\", \"Hello World!\",width=800, height=600)\r\n```\r\n\r\nYou can then create a window using the `start_window` function:\r\n```python\r\nPequena.start_window()\r\n``` \r\n\r\nBy default, Pequena uses the `EdgeChromium` backend for webview, but you can also use other backends such as `PyQt5`, `QtWebEngine`, and `Gtk`. But those will require additional installs\r\n\r\nYou can expose Python functions to your client-side JavaScript code by using the `expose_function` function:\r\n```python\r\ndef my_function():\r\n    return \"Hello, World!\"\r\nPequena.expose_function(my_function)\r\n``` \r\n\r\nIn your client-side JavaScript code, you can then call the Python function using the `PEQUENA` object:\r\n```Javascript\r\nconst result = await PEQUENA.my_function();\r\n```\r\n\r\n## License\r\nPequena is licensed under the MIT License.\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Lightweight desktop app framework",
    "version": "0.0.58",
    "project_urls": null,
    "split_keywords": [
        "python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68a46fff16cc953f4f89006c2fef4980b724339389c90d557bcf84d9ea0c0892",
                "md5": "1b6a3104443632bae2557bfa2f6d971f",
                "sha256": "46da9871cfff9ed430b140cfa388542b5a0877c2bf6c5dacfc4e55c1ac7ecee3"
            },
            "downloads": -1,
            "filename": "Pequena-0.0.58-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1b6a3104443632bae2557bfa2f6d971f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6725,
            "upload_time": "2023-05-25T18:45:44",
            "upload_time_iso_8601": "2023-05-25T18:45:44.707471Z",
            "url": "https://files.pythonhosted.org/packages/68/a4/6fff16cc953f4f89006c2fef4980b724339389c90d557bcf84d9ea0c0892/Pequena-0.0.58-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05187a3981f3593e4ef297215d339449708c19689d1aae9c8fe37626dead45ac",
                "md5": "75c20632760ad777e6d65c28a19f1ecf",
                "sha256": "93eaf059a3c226a82998ecdc01671f3bf9dfa4e3a1c0755bd5c75f294e8e7a44"
            },
            "downloads": -1,
            "filename": "Pequena-0.0.58.tar.gz",
            "has_sig": false,
            "md5_digest": "75c20632760ad777e6d65c28a19f1ecf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6195,
            "upload_time": "2023-05-25T18:45:46",
            "upload_time_iso_8601": "2023-05-25T18:45:46.848941Z",
            "url": "https://files.pythonhosted.org/packages/05/18/7a3981f3593e4ef297215d339449708c19689d1aae9c8fe37626dead45ac/Pequena-0.0.58.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-25 18:45:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pequena"
}
        
Elapsed time: 0.09668s