# IMSC Hypothetical Render Model (HRM) Validator
__ _ _ ____ ___ _ _ ____ _ _
( )( \/ )/ ___) / __)/ )( \( _ \( \/ )
)( / \/ \\___ \( (__ ) __ ( ) // \/ \
(__)\_)(_/(____/ \___)\_)(_/(__\_)\_)(_/
## Introduction
_imschrm_ validates [IMSC](https://www.w3.org/TR/ttml-imsc1.1) documents against the [IMSC Hypothetical Render Model
(HRM)](https://www.w3.org/TR/ttml-imsc1.1/#hypothetical-render-model), which constrains document complexity.
_imschrm_ consists of a library and command line application written in pure Python, and uses
[ttconv](https://github.com/sandflow/ttconv).
## Known issues
Issues are tracked at https://github.com/sandflow/imscHRM/issues.
## Quick start
```sh
pip install imschrm
imschrm <input IMSC document>
```
## Command line
```sh
cli.py [-h] [--itype {ttml,manifest}] input
```
* `input`: input file
* `--itype`: specifies whether the input file is a single IMSC document (`ttml`) (default) or a manifest (`manifest`) containing a
list of IMSC documents.
The manifest is a JSON file that conforms to the schema at `src/main/resources/json/manifest.json.schema`.
_EXAMPLE_:
```json
[
{
"begin": "12/24",
"end": 1,
"path": "doc001.ttml"
},
{
"begin": 1,
"end": null,
"path": "doc002.ttml"
}
]
```
## Dependencies
### General
The project uses [pipenv](https://pypi.org/project/pipenv/) to manage dependencies.
### Runtime
* [python >= 3.7](https://python.org)
* [ttconv == 1.0.1](https://github.com/sandflow/ttconv)
### Development
* [pylint](https://pypi.org/project/pylint/)
## Development environment
* run `pipenv install --dev`
* set the `PYTHONPATH` environment variable to `src/main/python`, e.g. `export PYTHONPATH=src/main/python`
* `pipenv run` can then be used
From the root directory of the project:
```sh
pipenv install --dev
mkdir build
export PYTHONPATH=src/main/python
pipenv run python src/main/python/imschrm/cli.py src/test/resources/ttml/fail001.ttml
```
Raw data
{
"_id": null,
"home_page": "https://www.sandflow.com",
"name": "imschrm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8, <4",
"maintainer_email": "",
"keywords": "ttml,imsc,smpte-tt,hrm,complexity",
"author": "Sandflow Consulting LLC",
"author_email": "info@sandflow.com",
"download_url": "https://files.pythonhosted.org/packages/87/bb/7effc46dea5ddf2f097865a3fcb1d13f2a78acd0e68d3af966cb487abd33/imschrm-1.0.0.tar.gz",
"platform": "",
"description": "# IMSC Hypothetical Render Model (HRM) Validator\n\n __ _ _ ____ ___ _ _ ____ _ _ \n ( )( \\/ )/ ___) / __)/ )( \\( _ \\( \\/ )\n )( / \\/ \\\\___ \\( (__ ) __ ( ) // \\/ \\\n (__)\\_)(_/(____/ \\___)\\_)(_/(__\\_)\\_)(_/\n\n## Introduction\n\n_imschrm_ validates [IMSC](https://www.w3.org/TR/ttml-imsc1.1) documents against the [IMSC Hypothetical Render Model\n(HRM)](https://www.w3.org/TR/ttml-imsc1.1/#hypothetical-render-model), which constrains document complexity.\n\n_imschrm_ consists of a library and command line application written in pure Python, and uses\n[ttconv](https://github.com/sandflow/ttconv).\n\n## Known issues\n\nIssues are tracked at https://github.com/sandflow/imscHRM/issues.\n\n## Quick start\n\n```sh\n pip install imschrm\n imschrm <input IMSC document>\n```\n\n## Command line\n\n```sh\ncli.py [-h] [--itype {ttml,manifest}] input\n```\n\n* `input`: input file\n* `--itype`: specifies whether the input file is a single IMSC document (`ttml`) (default) or a manifest (`manifest`) containing a\n list of IMSC documents.\n\nThe manifest is a JSON file that conforms to the schema at `src/main/resources/json/manifest.json.schema`.\n\n_EXAMPLE_:\n\n```json\n[\n {\n \"begin\": \"12/24\",\n \"end\": 1,\n \"path\": \"doc001.ttml\"\n },\n {\n \"begin\": 1,\n \"end\": null,\n \"path\": \"doc002.ttml\"\n }\n]\n```\n\n## Dependencies\n\n### General\n\nThe project uses [pipenv](https://pypi.org/project/pipenv/) to manage dependencies.\n\n### Runtime\n\n* [python >= 3.7](https://python.org)\n* [ttconv == 1.0.1](https://github.com/sandflow/ttconv)\n\n### Development\n\n* [pylint](https://pypi.org/project/pylint/)\n\n## Development environment\n\n* run `pipenv install --dev`\n* set the `PYTHONPATH` environment variable to `src/main/python`, e.g. `export PYTHONPATH=src/main/python`\n* `pipenv run` can then be used\n\nFrom the root directory of the project:\n\n```sh\npipenv install --dev\nmkdir build\nexport PYTHONPATH=src/main/python\npipenv run python src/main/python/imschrm/cli.py src/test/resources/ttml/fail001.ttml\n```\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Validates IMSC documents against the IMSC HRM",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/sandflow/imscHRM/issues",
"Homepage": "https://www.sandflow.com",
"Source": "https://github.com/sandflow/imscHRM"
},
"split_keywords": [
"ttml",
"imsc",
"smpte-tt",
"hrm",
"complexity"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70582e833a66890f1ede60d9b771f19c51889492147784c65fa3f3ffcb780033",
"md5": "5129d0af7982f43b7713094ced25e88f",
"sha256": "766e513585e492815787ff349351e2f6ccaf5edf54345c89c839031aa64fc494"
},
"downloads": -1,
"filename": "imschrm-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5129d0af7982f43b7713094ced25e88f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8, <4",
"size": 24287,
"upload_time": "2021-08-08T00:58:43",
"upload_time_iso_8601": "2021-08-08T00:58:43.653092Z",
"url": "https://files.pythonhosted.org/packages/70/58/2e833a66890f1ede60d9b771f19c51889492147784c65fa3f3ffcb780033/imschrm-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "87bb7effc46dea5ddf2f097865a3fcb1d13f2a78acd0e68d3af966cb487abd33",
"md5": "0be83c0e553aea6d18a0b668401edf63",
"sha256": "1e0d77d78f1665a4d5ad68c0349b99f637f33eda9fb65b62b2fe62b4a30bc2f8"
},
"downloads": -1,
"filename": "imschrm-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "0be83c0e553aea6d18a0b668401edf63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8, <4",
"size": 24694,
"upload_time": "2021-08-08T00:58:44",
"upload_time_iso_8601": "2021-08-08T00:58:44.579664Z",
"url": "https://files.pythonhosted.org/packages/87/bb/7effc46dea5ddf2f097865a3fcb1d13f2a78acd0e68d3af966cb487abd33/imschrm-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-08-08 00:58:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sandflow",
"github_project": "imscHRM",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "imschrm"
}
JSON
