Skip to main content

A Python Package for injecting curated themes and custom components into Trame applications

Project description

trame-facade

Author: John Duggan (dugganjw@ornl.gov)
Organization: Oak Ridge National Laboratory (ORNL)
License: MIT License


Overview

trame-facade is a Python package for streamlining development of Trame applications used in the NOVA project.

Installation

You can install this package directly with

pip install trame-facade

or with Poetry by placing the following in your pyproject.toml file (you can version lock with typical Semantic Versioning syntax)

[tool.poetry.dependencies]
trame-facade = "*"

Documentation

A user guide, examples, and a full API for this package can be found at https://nova-application-development.readthedocs.io/en/stable/.

Example Application

This package includes an example Trame application that shows commonly used Vuetify components for visual testing of our themes.

You can run it via:

poetry install
poetry run start [--server]

Formatting

poetry run ruff format

Linting

poetry run ruff check
poetry run mypy .

Testing

You will need a working Firefox install available in order to run all tests Selenium. Otherwise, all Selenium-based tests will fail.

poetry run pytest

or, with coverage

poetry run coverage run
poetry run coverage report

Contributing

Contributions are welcome! Please contact the author for more details.

License

This project is licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

trame_facade-0.7.1-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file trame_facade-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: trame_facade-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.15 Linux/5.15.0-119-generic

File hashes

Hashes for trame_facade-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f0667eacb9397d7891a682d7a08c52153d25ecf9166e82dc258cc5588dad03b
MD5 db697577da46a5a68ee993797447de88
BLAKE2b-256 c32e81136dd70ed21fe992ff8bff23946f9eb374ce654c8f51cafec5f631845c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page