trame-facade

Name	trame-facade JSON
Version	0.7.1 JSON
	download
home_page	None
Summary	A Python Package for injecting curated themes and custom components into Trame applications
upload_time	2024-10-31 17:57:10
maintainer	None
docs_url	None
author	Duggan, John
requires_python	<4.0,>=3.10
license	MIT
keywords	ndip python trame vuetify
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

```commandline
pip install trame-facade
```

or with [Poetry](https://python-poetry.org/) by placing the following in your pyproject.toml file (you can version lock with typical [Semantic Versioning](https://semver.org/) 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:
```commandline
poetry install
poetry run start [--server]
```

## Formatting
```commandline
poetry run ruff format
```

## Linting
```commandline
poetry run ruff check
poetry run mypy .
```

## Testing
You will need a working [Firefox](https://www.mozilla.org/en-US/firefox/) install available in order to run all tests [Selenium](https://www.selenium.dev/).
Otherwise, all Selenium-based tests will fail.

```commandline
poetry run pytest
```
or, with coverage
```commandline
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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "trame-facade",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "NDIP, Python, Trame, Vuetify",
    "author": "Duggan, John",
    "author_email": "dugganjw@ornl.gov",
    "download_url": null,
    "platform": null,
    "description": "# trame-facade\n\n**Author:** John Duggan (<dugganjw@ornl.gov>)\\\n**Organization:** Oak Ridge National Laboratory (ORNL)\\\n**License:** MIT License\n\n---\n\n## Overview\n`trame-facade` is a Python package for streamlining development of Trame applications used in the NOVA project.\n\n## Installation\nYou can install this package directly with\n\n```commandline\npip install trame-facade\n```\n\nor with [Poetry](https://python-poetry.org/) by placing the following in your pyproject.toml file (you can version lock with typical [Semantic Versioning](https://semver.org/) syntax)\n\n```\n[tool.poetry.dependencies]\ntrame-facade = \"*\"\n```\n\n## Documentation\nA user guide, examples, and a full API for this package can be found at https://nova-application-development.readthedocs.io/en/stable/.\n\n## Example Application\nThis package includes an example Trame application that shows commonly used Vuetify components for visual testing of our themes.\n\nYou can run it via:\n```commandline\npoetry install\npoetry run start [--server]\n```\n\n## Formatting\n```commandline\npoetry run ruff format\n```\n\n## Linting\n```commandline\npoetry run ruff check\npoetry run mypy .\n```\n\n## Testing\nYou will need a working [Firefox](https://www.mozilla.org/en-US/firefox/) install available in order to run all tests [Selenium](https://www.selenium.dev/).\nOtherwise, all Selenium-based tests will fail.\n\n```commandline\npoetry run pytest\n```\nor, with coverage\n```commandline\npoetry run coverage run\npoetry run coverage report\n```\n\n## Contributing\nContributions are welcome! Please contact the author for more details.\n\n## License\nThis project is licensed under the MIT license.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python Package for injecting curated themes and custom components into Trame applications",
    "version": "0.7.1",
    "project_urls": null,
    "split_keywords": [
        "ndip",
        " python",
        " trame",
        " vuetify"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c32e81136dd70ed21fe992ff8bff23946f9eb374ce654c8f51cafec5f631845c",
                "md5": "db697577da46a5a68ee993797447de88",
                "sha256": "1f0667eacb9397d7891a682d7a08c52153d25ecf9166e82dc258cc5588dad03b"
            },
            "downloads": -1,
            "filename": "trame_facade-0.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db697577da46a5a68ee993797447de88",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 25160,
            "upload_time": "2024-10-31T17:57:10",
            "upload_time_iso_8601": "2024-10-31T17:57:10.761950Z",
            "url": "https://files.pythonhosted.org/packages/c3/2e/81136dd70ed21fe992ff8bff23946f9eb374ce654c8f51cafec5f631845c/trame_facade-0.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-31 17:57:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "trame-facade"
}