| Name | XGEE JSON |
| Version |
0.3.13
JSON |
| download |
| home_page | None |
| Summary | eXtensible Graphical EMOF Editor - a framework for graphical editing single page web-applications |
| upload_time | 2025-01-23 09:37:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License |
| keywords |
emof
editor
web-application
modeling
graphical
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# XGEE Framework launcher
This is the XGEE framework launcher for starting XGEE applications on your computer.
# Purpose
The XGEE framework launcher is intended for hosting your XGEE application based on a YAML configuration file. It can host the single-page application through a *tornado* webserver as well as the EOQ model workspace.
# Preparing your App
To launch your XGEE application through the XGEE launcher you need to provide a YAML configuration file with the following parameters:
```
app:
name: My XGEE application # The application name
port: 8080 # The HTTP port of the application
eoq:
port: 8000 # The EOQ WebSocket port of the application
workspace: ./workspace # The workspace folder of your application containing all model files
actions: ./actions # The actions folder of your application containing your EOQ actions
meta: ./meta # The meta-model folder of your application containing your meta-models
```
You need to place all of your single-page application files in the *app* subdirectory of your application directory. These files will be hosted by the XGEE framework.
**Note**: The XGEE framework hosts all XGEE core files in the http://localhost:port/xgee-core directory. You do not have to bundle these files with your application. Instead you need to adjust your relative include paths in your application to this directory.
You only need to supply the meta-models required for your application. All XGEE related meta-files are added to your EOQ server automatically, if hosted through the XGEE framework launcher.
**Note**: The XGEE framework automatically loads the XGEE meta-models on your server. You should not include the XGEE meta-model files (e.g. *layout.ecore*) in your meta folder separately.
# Launching your XGEE application
You can launch your XGEE app by issuing the *xgee* command in your app directory from your terminal. If you want to launch multiple applications at once you can call the xgee command on a directory *xgee ./apps*. The launcher will display an overview of your launched XGEE apps.
| App Name | App Path | Web Instance | EOQ Instance |
| --------------- |:-----------:| :--------------------:|:--------------------:
| My application | ./myapp | http://localhost:8080 | ws://localhost:8000 |
Raw data
{
"_id": null,
"home_page": null,
"name": "XGEE",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "EMOF, editor, web-application, modeling, graphical",
"author": null,
"author_email": "Matthias Brunner <matthias.brunner@ils.uni-stuttgart.de>, Andreas Waldvogel <andreas.waldvogel@ils.uni-stuttgart.de>",
"download_url": "https://files.pythonhosted.org/packages/b8/57/c57b5896b1980e54ecc2619f500f100260a9531f158413f5f0b3da58489b/xgee-0.3.13.tar.gz",
"platform": null,
"description": "# XGEE Framework launcher\n\nThis is the XGEE framework launcher for starting XGEE applications on your computer. \n\n# Purpose\n\nThe XGEE framework launcher is intended for hosting your XGEE application based on a YAML configuration file. It can host the single-page application through a *tornado* webserver as well as the EOQ model workspace.\n\n# Preparing your App\n\nTo launch your XGEE application through the XGEE launcher you need to provide a YAML configuration file with the following parameters:\n\n```\napp:\n name: My XGEE application # The application name\n port: 8080 # The HTTP port of the application\neoq: \n port: 8000 # The EOQ WebSocket port of the application\n workspace: ./workspace # The workspace folder of your application containing all model files\n actions: ./actions # The actions folder of your application containing your EOQ actions\n meta: ./meta # The meta-model folder of your application containing your meta-models\n```\n\nYou need to place all of your single-page application files in the *app* subdirectory of your application directory. These files will be hosted by the XGEE framework. \n\n **Note**: The XGEE framework hosts all XGEE core files in the http://localhost:port/xgee-core directory. You do not have to bundle these files with your application. Instead you need to adjust your relative include paths in your application to this directory.\n\nYou only need to supply the meta-models required for your application. All XGEE related meta-files are added to your EOQ server automatically, if hosted through the XGEE framework launcher.\n\n **Note**: The XGEE framework automatically loads the XGEE meta-models on your server. You should not include the XGEE meta-model files (e.g. *layout.ecore*) in your meta folder separately.\n\n# Launching your XGEE application\n\nYou can launch your XGEE app by issuing the *xgee* command in your app directory from your terminal. If you want to launch multiple applications at once you can call the xgee command on a directory *xgee ./apps*. The launcher will display an overview of your launched XGEE apps.\n\n| App Name | App Path | Web Instance | EOQ Instance |\n| --------------- |:-----------:| :--------------------:|:--------------------:\n| My application | ./myapp | http://localhost:8080 | ws://localhost:8000 |\n\n\n\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "eXtensible Graphical EMOF Editor - a framework for graphical editing single page web-applications",
"version": "0.3.13",
"project_urls": {
"Documentation": "https://docs.xgee.de/",
"Homepage": "https://xgee.de",
"Repository": "https://gitlab.com/xgee/xgee-core"
},
"split_keywords": [
"emof",
" editor",
" web-application",
" modeling",
" graphical"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5aacb4e201bec17fffed650fb2974865e6891a43589161acb4546be509cd121d",
"md5": "455070221a515e9785362438098aa721",
"sha256": "6594e79a62088dfd6df68ddf22c4c3e4c438004816e56f6e5f507d17d5c74f97"
},
"downloads": -1,
"filename": "XGEE-0.3.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "455070221a515e9785362438098aa721",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5055708,
"upload_time": "2025-01-23T09:37:57",
"upload_time_iso_8601": "2025-01-23T09:37:57.194188Z",
"url": "https://files.pythonhosted.org/packages/5a/ac/b4e201bec17fffed650fb2974865e6891a43589161acb4546be509cd121d/XGEE-0.3.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b857c57b5896b1980e54ecc2619f500f100260a9531f158413f5f0b3da58489b",
"md5": "804ab6364a05e9023fdb6e5fab9bcf10",
"sha256": "d4120e830c8cb17d275e3c5b18e5c7e9f6c927ff8432053913b88b134bcd2618"
},
"downloads": -1,
"filename": "xgee-0.3.13.tar.gz",
"has_sig": false,
"md5_digest": "804ab6364a05e9023fdb6e5fab9bcf10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4700986,
"upload_time": "2025-01-23T09:37:59",
"upload_time_iso_8601": "2025-01-23T09:37:59.612185Z",
"url": "https://files.pythonhosted.org/packages/b8/57/c57b5896b1980e54ecc2619f500f100260a9531f158413f5f0b3da58489b/xgee-0.3.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 09:37:59",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "xgee",
"gitlab_project": "xgee-core",
"lcname": "xgee"
}
