ixbrl-viewer 1.4.54__tar.gz → 1.4.82__tar.gz

ixbrl_viewer-1.4.54/LICENSE → ixbrl_viewer-1.4.82/LICENSE.md

@@ -1,22 +1,16 @@
+# License
 
+Copyright © 2019-present Workiva, Inc.
 
-ixbrl-viewer
-
-Copyright 2019 Workiva Inc.
-
-
-Licensed under the Apache License, Version 2.0 (the "License"); 
+Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
+<http://www.apache.org/licenses/LICENSE-2.0>
 
-http://www.apache.org/licenses/LICENSE-2.0
-
-
-Unless required by applicable law or agreed to in writing, software 
-distributed under the License is distributed on an "AS IS" BASIS, 
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
-See the License for the specific language governing permissions and
-limitations under the License.
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
 
 ---
 This ixbrl-viewer software includes a number of subcomponents with separate copyright notices and/or license

ixbrl_viewer-1.4.82/MANIFEST.in

@@ -0,0 +1,19 @@
+graft iXBRLViewerPlugin/viewer/dist
+prune .github
+prune docs
+prune examples
+prune samples
+prune tests
+prune tools
+exclude .babelrc
+exclude .gitignore
+exclude .npmignore
+exclude .npmrc
+exclude .readthedocs.yaml
+exclude CODEOWNERS
+exclude jest.config.json
+exclude Makefile
+exclude package-lock.json
+exclude package.json
+exclude requirements*.txt
+exclude tox.ini

{ixbrl_viewer-1.4.54/ixbrl_viewer.egg-info → ixbrl_viewer-1.4.82}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: ixbrl-viewer
-Version: 1.4.54
+Version: 1.4.82
 Summary: The Arelle iXBRL Viewer allows iXBRL reports to be viewed interactively in a web browser.
 Author-email: "arelle.org" <support@arelle.org>
-License: Apache-2.0
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://arelle.org/
 Project-URL: Downloads, https://arelle.org/arelle/pub/
 Project-URL: Documentation, https://arelle.org/arelle/documentation/
@@ -16,49 +16,87 @@ Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Text Processing :: Markup :: XML
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE
+License-File: LICENSE.md
 License-File: NOTICE
-Requires-Dist: lxml<6,>=4
+Requires-Dist: lxml<7,>=4
 Provides-Extra: arelle
 Requires-Dist: arelle_release==2.*; extra == "arelle"
 Provides-Extra: dev
-Requires-Dist: flake8==7.1.1; extra == "dev"
+Requires-Dist: flake8==7.3.0; extra == "dev"
 Requires-Dist: lxml-stubs==0.5.1; extra == "dev"
-Requires-Dist: mypy==1.14.1; extra == "dev"
-Requires-Dist: pytest==8.3.4; extra == "dev"
-Requires-Dist: typing-extensions==4.12.2; extra == "dev"
+Requires-Dist: mypy==1.19.0; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: typing-extensions==4.15.0; extra == "dev"
+Dynamic: license-file
 
 # Arelle iXBRL Viewer
 
+[![PyPI](https://img.shields.io/pypi/v/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![NPM Version](https://img.shields.io/npm/v/ixbrl-viewer)](https://www.npmjs.com/package/ixbrl-viewer)
+[![Read the Docs](https://img.shields.io/readthedocs/arelle-ixbrl-viewer)](https://arelle-ixbrl-viewer.readthedocs.io/)
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/ixbrl-viewer-demo.gif)
 
+## Table of Contents
+
+- [Arelle iXBRL Viewer](#arelle-ixbrl-viewer)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Documentation](#documentation)
+  - [Installation](#installation)
+  - [Accessing the JavaScript viewer application](#accessing-the-javascript-viewer-application)
+    - [Accessing via the CDN](#accessing-via-the-cdn)
+    - [Accessing via Github](#accessing-via-github)
+    - [Building the JavaScript locally](#building-the-javascript-locally)
+  - [JavaScript Versioning](#javascript-versioning)
+  - [Producing an ixbrl-viewer via the Arelle GUI](#producing-an-ixbrl-viewer-via-the-arelle-gui)
+    - [Preparing an iXBRL file via the GUI](#preparing-an-ixbrl-file-via-the-gui)
+    - [Preparing an iXBRL document set using the Arelle GUI](#preparing-an-ixbrl-document-set-using-the-arelle-gui)
+  - [Producing an ixbrl-viewer via the Arelle command line](#producing-an-ixbrl-viewer-via-the-arelle-command-line)
+    - [Preparing an iXBRL file via the command line](#preparing-an-ixbrl-file-via-the-command-line)
+    - [Preparing an iXBRL document set](#preparing-an-ixbrl-document-set)
+    - [Using build-viewer.py](#using-build-viewerpy)
+  - [Stub viewer mode](#stub-viewer-mode)
+  - [Optional Features](#optional-features)
+    - [Feature: Review Mode](#feature-review-mode)
+  - [Runtime config](#runtime-config)
+  - [Disable viewer loading](#disable-viewer-loading)
+  - [Running tests](#running-tests)
+    - [Running unit tests](#running-unit-tests)
+    - [Running Puppeteer tests](#running-puppeteer-tests)
+  - [👥 Contributors](#-contributors)
+  - [License](#license)
+
+## Description
+
 The [Arelle](https://arelle.org/) iXBRL Viewer allows [Inline XBRL](https://www.xbrl.org/ixbrl) (or iXBRL) reports to be
 viewed interactively in a web browser.  The viewer allows users to access the tagged XBRL data embedded in an iXBRL
 report.  Key features include:
 
-* Full text search on taxonomy labels and references
-* View full details of tagged facts
-* Export tables to Excel
-* Visualize and navigate calculation relationships
-* Produce on-the-fly graphs using XBRL data
+- Full text search on taxonomy labels and references
+- View full details of tagged facts
+- Export tables to Excel
+- Visualize and navigate calculation relationships
+- Produce on-the-fly graphs using XBRL data
 
 A sample viewer is provided in the [examples](https://github.com/Arelle/ixbrl-viewer/blob/master/examples/README.md) for those interested.
 
 The viewer project consists of two components:
 
-* A plugin for the [Arelle](https://www.arelle.org) XBRL tool
-* The Javascript viewer application
+- A plugin for the [Arelle](https://www.arelle.org) XBRL tool
+- The Javascript viewer application
 
 In order to view an iXBRL report in the viewer, it must first be prepared using
 the Arelle plugin.  The preparation process updates the iXBRL file to include:
@@ -77,9 +115,15 @@ in a separate file.  See Stub Viewer Mode below.
 The JavaScript viewer application is a single JavaScript file called ixbrlviewer.js. It
 contains all of the JavaScript that runs the viewer functionality.
 
+## Documentation
+
+Need help with the Arelle iXBRL Viewer? Go check out [our documentation][read-the-docs].
+
+[read-the-docs]: https://arelle-ixbrl-viewer.readthedocs.io/
+
 ## Installation
 
-The Python portion of this repo is developed using Python 3.12.
+The Python portion of this repo is developed using Python 3.14.
 
 1. Clone the [iXBRL Viewer git repository][ixbrlviewer-github].
 2. Download and install [Arelle][arelle-download]
@@ -173,9 +217,9 @@ python3 Arelle/arelleCmdLine.py --plugins=<path to iXBRLViewerPlugin> -f ixbrl-r
 
 Notes:
 
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
@@ -205,18 +249,18 @@ python3 Arelle/arelleCmdLine.py --plugins '/path/to/iXBRLViewerPlugin|inlineXbrl
 
 Notes:
 
-* The first file specified is the "primary" file, and should be opened in a
+- The first file specified is the "primary" file, and should be opened in a
   browser to use the viewer.  The other files will be loaded in separate tabs
   within the viewer.
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
   3. A relative url to the locally built ixviewer.js
 
-* Due to browser security restrictions, the resulting viewer cannot be loaded
+- Due to browser security restrictions, the resulting viewer cannot be loaded
   directly from `file:` URLs; it must be served by a web server.
 
 ### Using build-viewer.py
@@ -263,11 +307,12 @@ The downside of this mode is that due to browser security restrictions, the
 viewer cannot be loaded directly from files (using `file:` URLs); they must be
 served by a web server.
 
-# Optional Features
+## Optional Features
 
 Some features are disabled by default but can be enabled at generation time or with query parameters.
 
 To enable features:
+
 - Via CLI: `--viewer-feature-{feature name}`
 - Via query parameter:`?{feature name}=true`
 
@@ -286,7 +331,8 @@ This table uses the 'review' feature as an example to demonstrate how these opti
 | `review` | `true`      | `enabled`  |
 | `review` | `false`     | `disabled` |
 
-## Feature: Review Mode
+### Feature: Review Mode
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/review-mode.png)
 
 A review mode is available that is intended to assist in reviewing partially tagged or incomplete documents.
@@ -296,7 +342,7 @@ This mode replaces the namespace-based highlighting with optional highlighting b
 |---------------------------|----------------|
 | `--viewer-feature-review` | `?review=true` |
 
-# Runtime config
+## Runtime config
 
 When launched, the viewer will check for the existence of
 `ixbrlviewer.config.json` in the same directory as `ixbrlviewer.js`.  If found,
@@ -304,36 +350,36 @@ this will be loaded and used to configure the viewer.
 
 The file supports the following keys:
 
-* `features` - a JSON object containing defaults for features. These will be
+- `features` - a JSON object containing defaults for features. These will be
 overridden by features defined at generation time, and then by query
 parameters, as defined above.
 
-* `skin` - a JSON object supporting the following keys:
+- `skin` - a JSON object supporting the following keys:
 
-    * `stylesheetUrl` - a URL to additional CSS definitions.
-    * `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
-    * `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
+  - `stylesheetUrl` - a URL to additional CSS definitions.
+  - `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
+  - `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
 
-* `taxonomyNames` - a JSON object where:
+- `taxonomyNames` - a JSON object where:
 
-    * Keys are strings that will be treated as a regular expression to match
+  - Keys are strings that will be treated as a regular expression to match
       against a namespace.
-    * Values are an array of (prefix, name) where "prefix" is the preferred
+  - Values are an array of (prefix, name) where "prefix" is the preferred
       namespace prefix for the namespace, and "name" is a short descriptive
       name for the taxonomy.
 
 Relative URLs defined in the config file are resolved relative to the config file.
 
-# Disable viewer loading
+## Disable viewer loading
 
 Loading of the viewer can be disabled by specifying `?disable-viewer` as a
 query parameter.  This will leave the iXBRL document loaded in the browser, but
 without any viewer functionality.  In the case of an iXBRL document set, or
 multi-document viewer, the first document will be shown.
 
-# Running tests
+## Running tests
 
-## Running unit tests
+### Running unit tests
 
 In order to run the javascript unit tests make sure that you have installed all of the npm requirements.
 
@@ -343,7 +389,7 @@ In order to run the python unit tests make sure that you have pip installed requ
 
 Run the following command to run python unit tests: `pytest tests/unit_tests`
 
-## Running Puppeteer tests
+### Running Puppeteer tests
 
 All commands should be run from repository root
 
@@ -360,16 +406,31 @@ All commands should be run from repository root
     npm run puppeteerServe 
     ```
 
-    * This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
-    * Currently changes to application code require restarting this step to take effect.
+    - This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
+    - Currently changes to application code require restarting this step to take effect.
 4. Start the puppeteer tests
-    * [Terminal 2]:
+    - [Terminal 2]:
 
        ```shell
        npm run test:puppeteer
        ```
 
-    * IDE:
-      * Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
+    - IDE:
+      - Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
       ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/tests/puppeteer/puppeteer_test_run_via_intellij.jpg)
-      * Debug runs with breakpoints are also typically supported.
+      - Debug runs with breakpoints are also typically supported.
+
+## 👥 Contributors
+
+<div align="center">
+  <a href="https://github.com/Arelle/ixbrl-viewer/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=Arelle/ixbrl-viewer&max=100&columns=10" style="margin: 5px;" />
+  </a>
+  <p>Join our community and become a contributor today! 🚀 </p>
+</div>
+
+## License
+
+[Apache License 2.0][license]
+
+[license]: https://arelle-ixbrl-viewer.readthedocs.io/en/latest/license.html

{ixbrl_viewer-1.4.54 → ixbrl_viewer-1.4.82}/README.md

@@ -1,23 +1,60 @@
 # Arelle iXBRL Viewer
 
+[![PyPI](https://img.shields.io/pypi/v/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ixbrl-viewer)](https://pypi.org/project/ixbrl-viewer/)
+[![NPM Version](https://img.shields.io/npm/v/ixbrl-viewer)](https://www.npmjs.com/package/ixbrl-viewer)
+[![Read the Docs](https://img.shields.io/readthedocs/arelle-ixbrl-viewer)](https://arelle-ixbrl-viewer.readthedocs.io/)
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/ixbrl-viewer-demo.gif)
 
+## Table of Contents
+
+- [Arelle iXBRL Viewer](#arelle-ixbrl-viewer)
+  - [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Documentation](#documentation)
+  - [Installation](#installation)
+  - [Accessing the JavaScript viewer application](#accessing-the-javascript-viewer-application)
+    - [Accessing via the CDN](#accessing-via-the-cdn)
+    - [Accessing via Github](#accessing-via-github)
+    - [Building the JavaScript locally](#building-the-javascript-locally)
+  - [JavaScript Versioning](#javascript-versioning)
+  - [Producing an ixbrl-viewer via the Arelle GUI](#producing-an-ixbrl-viewer-via-the-arelle-gui)
+    - [Preparing an iXBRL file via the GUI](#preparing-an-ixbrl-file-via-the-gui)
+    - [Preparing an iXBRL document set using the Arelle GUI](#preparing-an-ixbrl-document-set-using-the-arelle-gui)
+  - [Producing an ixbrl-viewer via the Arelle command line](#producing-an-ixbrl-viewer-via-the-arelle-command-line)
+    - [Preparing an iXBRL file via the command line](#preparing-an-ixbrl-file-via-the-command-line)
+    - [Preparing an iXBRL document set](#preparing-an-ixbrl-document-set)
+    - [Using build-viewer.py](#using-build-viewerpy)
+  - [Stub viewer mode](#stub-viewer-mode)
+  - [Optional Features](#optional-features)
+    - [Feature: Review Mode](#feature-review-mode)
+  - [Runtime config](#runtime-config)
+  - [Disable viewer loading](#disable-viewer-loading)
+  - [Running tests](#running-tests)
+    - [Running unit tests](#running-unit-tests)
+    - [Running Puppeteer tests](#running-puppeteer-tests)
+  - [👥 Contributors](#-contributors)
+  - [License](#license)
+
+## Description
+
 The [Arelle](https://arelle.org/) iXBRL Viewer allows [Inline XBRL](https://www.xbrl.org/ixbrl) (or iXBRL) reports to be
 viewed interactively in a web browser.  The viewer allows users to access the tagged XBRL data embedded in an iXBRL
 report.  Key features include:
 
-* Full text search on taxonomy labels and references
-* View full details of tagged facts
-* Export tables to Excel
-* Visualize and navigate calculation relationships
-* Produce on-the-fly graphs using XBRL data
+- Full text search on taxonomy labels and references
+- View full details of tagged facts
+- Export tables to Excel
+- Visualize and navigate calculation relationships
+- Produce on-the-fly graphs using XBRL data
 
 A sample viewer is provided in the [examples](https://github.com/Arelle/ixbrl-viewer/blob/master/examples/README.md) for those interested.
 
 The viewer project consists of two components:
 
-* A plugin for the [Arelle](https://www.arelle.org) XBRL tool
-* The Javascript viewer application
+- A plugin for the [Arelle](https://www.arelle.org) XBRL tool
+- The Javascript viewer application
 
 In order to view an iXBRL report in the viewer, it must first be prepared using
 the Arelle plugin.  The preparation process updates the iXBRL file to include:
@@ -36,9 +73,15 @@ in a separate file.  See Stub Viewer Mode below.
 The JavaScript viewer application is a single JavaScript file called ixbrlviewer.js. It
 contains all of the JavaScript that runs the viewer functionality.
 
+## Documentation
+
+Need help with the Arelle iXBRL Viewer? Go check out [our documentation][read-the-docs].
+
+[read-the-docs]: https://arelle-ixbrl-viewer.readthedocs.io/
+
 ## Installation
 
-The Python portion of this repo is developed using Python 3.12.
+The Python portion of this repo is developed using Python 3.14.
 
 1. Clone the [iXBRL Viewer git repository][ixbrlviewer-github].
 2. Download and install [Arelle][arelle-download]
@@ -132,9 +175,9 @@ python3 Arelle/arelleCmdLine.py --plugins=<path to iXBRLViewerPlugin> -f ixbrl-r
 
 Notes:
 
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
@@ -164,18 +207,18 @@ python3 Arelle/arelleCmdLine.py --plugins '/path/to/iXBRLViewerPlugin|inlineXbrl
 
 Notes:
 
-* The first file specified is the "primary" file, and should be opened in a
+- The first file specified is the "primary" file, and should be opened in a
   browser to use the viewer.  The other files will be loaded in separate tabs
   within the viewer.
-* "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
-* The plugin path needs to an absolute file path to the ixbrl-viewer plugin
-* The viewer url can be one of the following:
+- "Arelle/arelleCmdLine.py" should be the path to your installation of Arelle
+- The plugin path needs to an absolute file path to the ixbrl-viewer plugin
+- The viewer url can be one of the following:
 
   1. `https://cdn.jsdelivr.net/npm/ixbrl-viewer@<version>/iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js`
   2. A relative url to the downloaded ixviewer.js from github
   3. A relative url to the locally built ixviewer.js
 
-* Due to browser security restrictions, the resulting viewer cannot be loaded
+- Due to browser security restrictions, the resulting viewer cannot be loaded
   directly from `file:` URLs; it must be served by a web server.
 
 ### Using build-viewer.py
@@ -222,11 +265,12 @@ The downside of this mode is that due to browser security restrictions, the
 viewer cannot be loaded directly from files (using `file:` URLs); they must be
 served by a web server.
 
-# Optional Features
+## Optional Features
 
 Some features are disabled by default but can be enabled at generation time or with query parameters.
 
 To enable features:
+
 - Via CLI: `--viewer-feature-{feature name}`
 - Via query parameter:`?{feature name}=true`
 
@@ -245,7 +289,8 @@ This table uses the 'review' feature as an example to demonstrate how these opti
 | `review` | `true`      | `enabled`  |
 | `review` | `false`     | `disabled` |
 
-## Feature: Review Mode
+### Feature: Review Mode
+
 ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/examples/review-mode.png)
 
 A review mode is available that is intended to assist in reviewing partially tagged or incomplete documents.
@@ -255,7 +300,7 @@ This mode replaces the namespace-based highlighting with optional highlighting b
 |---------------------------|----------------|
 | `--viewer-feature-review` | `?review=true` |
 
-# Runtime config
+## Runtime config
 
 When launched, the viewer will check for the existence of
 `ixbrlviewer.config.json` in the same directory as `ixbrlviewer.js`.  If found,
@@ -263,36 +308,36 @@ this will be loaded and used to configure the viewer.
 
 The file supports the following keys:
 
-* `features` - a JSON object containing defaults for features. These will be
+- `features` - a JSON object containing defaults for features. These will be
 overridden by features defined at generation time, and then by query
 parameters, as defined above.
 
-* `skin` - a JSON object supporting the following keys:
+- `skin` - a JSON object supporting the following keys:
 
-    * `stylesheetUrl` - a URL to additional CSS definitions.
-    * `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
-    * `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
+  - `stylesheetUrl` - a URL to additional CSS definitions.
+  - `faviconUrl` - a URL to an icon file to be used as the favicon for the viewer.
+  - `footerLogoHtml` - a fragment of HTML that will be included in place of the standard footer logo.
 
-* `taxonomyNames` - a JSON object where:
+- `taxonomyNames` - a JSON object where:
 
-    * Keys are strings that will be treated as a regular expression to match
+  - Keys are strings that will be treated as a regular expression to match
       against a namespace.
-    * Values are an array of (prefix, name) where "prefix" is the preferred
+  - Values are an array of (prefix, name) where "prefix" is the preferred
       namespace prefix for the namespace, and "name" is a short descriptive
       name for the taxonomy.
 
 Relative URLs defined in the config file are resolved relative to the config file.
 
-# Disable viewer loading
+## Disable viewer loading
 
 Loading of the viewer can be disabled by specifying `?disable-viewer` as a
 query parameter.  This will leave the iXBRL document loaded in the browser, but
 without any viewer functionality.  In the case of an iXBRL document set, or
 multi-document viewer, the first document will be shown.
 
-# Running tests
+## Running tests
 
-## Running unit tests
+### Running unit tests
 
 In order to run the javascript unit tests make sure that you have installed all of the npm requirements.
 
@@ -302,7 +347,7 @@ In order to run the python unit tests make sure that you have pip installed requ
 
 Run the following command to run python unit tests: `pytest tests/unit_tests`
 
-## Running Puppeteer tests
+### Running Puppeteer tests
 
 All commands should be run from repository root
 
@@ -319,16 +364,31 @@ All commands should be run from repository root
     npm run puppeteerServe 
     ```
 
-    * This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
-    * Currently changes to application code require restarting this step to take effect.
+    - This command generates the `ixbrlviewer.js`, uses Arelle to generate several test files, then serves the files via a nodejs http-server.
+    - Currently changes to application code require restarting this step to take effect.
 4. Start the puppeteer tests
-    * [Terminal 2]:
+    - [Terminal 2]:
 
        ```shell
        npm run test:puppeteer
        ```
 
-    * IDE:
-      * Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
+    - IDE:
+      - Many of the IDE's on the market can run tests via the UI.  The following is an example configuration for intellij.  Once set you can right-click on the test name or file and select the run option.
       ![ixbrl-viewer](https://raw.githubusercontent.com/Arelle/ixbrl-viewer/master/tests/puppeteer/puppeteer_test_run_via_intellij.jpg)
-      * Debug runs with breakpoints are also typically supported.
+      - Debug runs with breakpoints are also typically supported.
+
+## 👥 Contributors
+
+<div align="center">
+  <a href="https://github.com/Arelle/ixbrl-viewer/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=Arelle/ixbrl-viewer&max=100&columns=10" style="margin: 5px;" />
+  </a>
+  <p>Join our community and become a contributor today! 🚀 </p>
+</div>
+
+## License
+
+[Apache License 2.0][license]
+
+[license]: https://arelle-ixbrl-viewer.readthedocs.io/en/latest/license.html

{ixbrl_viewer-1.4.54 → ixbrl_viewer-1.4.82}/iXBRLViewerPlugin/__init__.py

@@ -129,7 +129,15 @@ def processModel(cntlr: Cntlr, modelXbrl: ModelXbrl):
         print(ex)
     except Exception as ex:
         tb = traceback.format_tb(sys.exc_info()[2])
-        cntlr.addToLog(f"Exception {ex} \nTraceback {tb}", messageCode=EXCEPTION_MESSAGE_CODE)
+        cntlr.addToLog(
+            "Exception %(ex)s\nTraceback %(traceback)s",
+            messageCode=EXCEPTION_MESSAGE_CODE,
+            level=logging.ERROR,
+            messageArgs={
+                'ex': ex,
+                'traceback': tb,
+            },
+        )
 
 def generateViewer(
         cntlr: Cntlr,

ixbrl_viewer-1.4.82/iXBRLViewerPlugin/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.4.82'
+__version_tuple__ = version_tuple = (1, 4, 82)
+
+__commit_id__ = commit_id = 'gb554e4358'