Skip to main content

PyPI Downloads

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
  consolelog: true              # Logs the EOQ websocket log to the console. Alternatively, look at log/info.log

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

Metadata

Release files for XGEE 0.3.22

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for XGEE 0.3.22
File Size Uploaded Provenance Actions
xgee-0.3.22.tar.gz 4.7 MB Without provenance Details for xgee-0.3.22.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for XGEE 0.3.22
File Interpreter ABI Platform Actions
xgee-0.3.22-py3-none-any.whl Python 3 none any Details for xgee-0.3.22-py3-none-any.whl

Total release size: 9.8 MB

Release files / xgee-0.3.22.tar.gz

Download URL xgee-0.3.22.tar.gz
Size 4.7 MB
Tags Source
SHA-256 checksum
How to use checksums
09a6d7caaa3fc69a4502cbf148d68d42a266e34247ac6ad2ff9d8a29af4674bc
BLAKE2b-256 checksum
How to use checksums
17e82096dbb1b8401978c04d888c99e52751af7e4ac4cfa63e919407f2c9171e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / xgee-0.3.22-py3-none-any.whl

Download URL xgee-0.3.22-py3-none-any.whl
Size 5.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
f6b1785a58a076da00b53596a90a84eccb4b70d576ce748da3ccb21d57e738bb
BLAKE2b-256 checksum
How to use checksums
2dc6dd12ccda30bd5bf689b26b4a44ae16f7cc5d38bb051d5760df1c4f028d1f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for XGEE 0.3.22

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.22 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page