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
Use configuration.yml for launcher and server settings such as ports, workspace paths, logging, and deployment networking. Application and plugin settings belong in the application's app/app-conf.js; runtime endpoints are supplied automatically by the launcher.
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
consolelog: true # Logs the EOQ websocket log to the console. Alternatively, look at log/info.log
websocketPingInterval: 60 # Optional interval in seconds for WebSocket keepalive pings
websocketPingInterval optionally sends native keepalive pings to prevent reverse proxies from closing idle WebSocket connections.
By default, the generated browser configuration connects directly to the EOQ host and port above. For a reverse proxy that exposes EOQ on the same public origin as the application, add a browser-visible root-relative URL:
browser:
eoq:
url: /ws/eoq.do
The launcher then generates ws:// or wss:// from the page's actual protocol
and host. An explicit absolute ws:// or wss:// URL is also supported. These
browser settings do not change where the EOQ server listens.
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 |
3 maintainers
Release files for XGEE 0.3.36
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xgee-0.3.36.tar.gz | 4.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xgee-0.3.36-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.7 MB
Release files / xgee-0.3.36.tar.gz
| Download URL | xgee-0.3.36.tar.gz |
|---|---|
| Size | 4.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c636a10c696773614530fdaf427073814040086ab3c61dfcfb4e748a35f88f33
|
|
BLAKE2b-256 checksum How to use checksums |
078a7d3eb6053004c5c2e88adffba972cc455eca0bcd53fc5e708612f901caa1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / xgee-0.3.36-py3-none-any.whl
| Download URL | xgee-0.3.36-py3-none-any.whl |
|---|---|
| Size | 5.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6df9fcb8c19f930067f7afb3507763b286b14cea8dc15d282bdeabd358dc4926
|
|
BLAKE2b-256 checksum How to use checksums |
1c7b6017c4ba2263d5ef95c176c8ffaca34944fa8c5ff862acbdcd26a5d29144
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
