uvl

git.splent.io/splent-io/splent_feature_uvl

v0.6.1 full Refines hubfile

About

The UVL artifact type of a hub: the UVL model as a file type (its mandatory check, its feature model, its Glencoe, DIMACS and SPLOT formats), its viewer and LaTeX export, the import by URL and the bridge with flamapyIDE

Refinement

Refines
Extends models
Hubfile with HubfileFeatureModelMixin

It changes hubfile in place, without a fork, so the product installs both.

Provides

Models
FeatureModel
Services
FeatureModelServiceFlamapyService
Routes
/api/v1/auth/status/dataset/import/dataset/import//flamapy/to_cnf/<int:file_id>/flamapy/to_glencoe/<int:file_id>/flamapy/to_splot/<int:file_id>/flamapy/valid/<int:file_id>/hubfile/to_latex/<int:file_id>/hubfile/to_latex_zip/<int:file_id>
Hooks filled
dataset.files.nounsdataset.form.scriptshubfile.workbench.actionshubfile.workbench.contenthubfile.workbench.dialogshubfile.workbench.export_itemshubfile.workbench.file_urlshubfile.workbench.file_viewhubfile.workbench.panelhubfile.workbench.scripts
Translations
es

Commands

  • $ splent feature:uvl generate [OPTIONS]

    Generate the missing download formats (Glencoe, DIMACS, SPLOT) of the UVL models.

  • $ splent feature:uvl pending [OPTIONS]

    Show how many hubfiles are missing at least one download format.

Run them in your workspace once the feature is installed in the selected product.

Configuration

Setting Default What it does
FLAMAPY_IDE_ORIGINS https://ide.flamapy.org The flamapyIDE sites that may ask /api/v1/auth/status who is signed in and post a model to dataset's /api/v1/datasets/upload, both with the user's cookies. Exact origins only.
FLAMAPY_IDE_URL https://ide.flamapy.org The flamapyIDE the workbench's "Open with Flamapy IDE" opens a model in. Empty draws no link.
UVL_EXTENSIONS .uvl The extensions of a UVL model, whatever their case, and the largest one the hub takes: the uvl type of hubfile's registry, which the upload zone, its help text and the upload's request cap read.
UVL_MAX_SIZE 10M No description yet.
UVL_DERIVED_FORMATS glencoe,dimacs,splot The formats every model is transformed into, which a dataset's archive carries and the workbench offers.
UVL_IMPORT_ALLOWED_HOSTS ide.flamapy.org,raw.githubusercontent.com The hosts a model may be imported from by URL (/dataset/import?import=), flamapyIDE's way in. Any other host is refused, and so is one that resolves to an address that is not public. dataset called it DATASET_IMPORT_ALLOWED_HOSTS up to 0.5.
UVL_IMPORT_MAX_SIZE 10M The most an imported model may have (DATASET_IMPORT_MAX_BYTES up to dataset 0.5), and the seconds its fetch may take in all.
UVL_IMPORT_TIMEOUT 15 No description yet.
UVL_TRANSFORM_TIMEOUT 300 No description yet.
UVL_TRANSFORM_MEMORY_MB 1536 No description yet.

These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.

Dependencies

Works better with
Listens to
hubfile-created

In product lines

  • openhubs_spl In a group One or more of the tipo_artefacto group, when a product takes that group Needs auth dataset hubfile

Extension points

Templates
hooks/uvl_export_items.htmlhooks/uvl_ide_link.htmlhooks/uvl_latex_button.htmlhooks/uvl_latex_dialogs.htmlhooks/uvl_workbench_scripts.htmluvl/import.html
Services
FeatureModelServiceFlamapyService
Models
FeatureModel
Routes
A refinement can add routes to its blueprint

Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.

Compatibility

Python
>=3.13
SPLENT framework
>=1.30.0
Python packages
flamapy-fw==2.5.0flamapy-fm==2.5.0flamapy-sat==2.5.0flamapy-bdd==2.5.0uvlparser==2.5.0antlr4-python3-runtime==4.13.1dd==0.6.0flask-cors==6.0.2