Please add SlicerPySERA extension metadata

[MohammadRSalmanpour]

This is an extension of PySERA Library for 3D Slicer

New extension

Tier 1

Any extension that is listed in the Extensions Catalog must fulfill these requirements.

• [*] Extension has a reasonable name (not too general, not too narrow, suggests what the extension is for). The extension name should not start with Slicer (unless it explicitly provides a bridge between Slicer and a tool or library), because it would make it more difficult to find extensions if the name of many started with the same word.
• [*] Repository name is Slicer+ExtensionName (except if the repository that hosts the extension can be also used without Slicer)
• [*] Repository is associated with 3d-slicer-extension GitHub topic so that it is listed here. To edit topics, click the settings icon in the right side of "About" section header and enter 3d-slicer-extension in "Topics" and click "Save changes". To learn more about topics, read https://help.github.com/en/articles/about-topics
• [*] Extension description summarizes in 1-2 sentences what the extension is usable (should be understandable for non-experts)
• [*] Any known related patents must be mentioned in the extension description.
• [*] LICENSE.txt is present in the repository root and the name of the license is mentioned in extension homepage. We suggest you use a permissive license that includes patent and contribution clauses. This will help protect developers and ensure the code remains freely available. MIT (https://choosealicense.com/licenses/mit/) or Apache (https://choosealicense.com/licenses/apache-2.0/) license is recommended. Read here to learn more about licenses. If source code license is more restrictive for users than MIT, BSD, Apache, or 3D Slicer license then describe the reason for the license choice and include the name of the used license in the extension description.
• [*] Extension URL and revision (scmurl, scmrevision) is correct, consider using a branch name (main, release, ...) instead of a specific git hash to avoid re-submitting pull request whenever the extension is updated
• [*] Extension icon URL is correct (do not use the icon's webpage but the raw data download URL that you get from the download button - it should look something like this: https://raw.githubusercontent.com/user/repo/main/SomeIcon.png)
• [*] Screenshot URLs (screenshoturls) are correct, contains at least one
• [*] Content of submitted json file is consistent with the top-level CMakeLists.txt file in the repository (dependencies, etc. are the same)
• Homepage URL points to valid webpage containing the following:
  • [*] Extension name
  • [*] Short description: 1-2 sentences, which summarizes what the extension is usable for
  • [*] At least one nice, informative image, that illustrates what the extension can do. It may be a screenshot.
  • [*] Description of contained modules: at one sentence for each module
  • [*] Publication: link to publication and/or to PubMed reference (if available)
• Hide unused github features (such as Wiki, Projects, and Discussions, Releases, Packages) in the repository to reduce noise/irrelevant information:
  • [*] Click Settings and in repository settings uncheck Wiki, Projects, and Discussions (if they are currently not used).
  • [*] Click the settings icon next to About in the top-right corner of the repository main page and uncheck Releases and Packages (if they are currently not used)
• The extension is safe:
  • [*] Does not include or download binaries from unreliable sources
  • [*] Does not send any information anywhere without user consent (explicit opt-in is required)

Tier 3

Community-supported extensions.

• [*] Documentation, tutorial, and test data are provided for most modules. A tutorial provides step-by-step description of at least the most typical use case, include a few screenshots. Any sample data sets that is used in tutorials must be registered with the Sample Data module to provide easy access to the user.
• [*] Follows programming and user interface conventions of 3D Slicer (e.g., GUI and logic are separated, usage of popups is minimized, no unnecessary custom GUI styling, etc.)
• [*] The extension can be successfully built and packaged on all supported platforms (Windows, macOS, Linux)
• [*] Maintainers respond to issues and pull request submitted to the extension's repository.
• [*] Maintainers respond to questions directly addressed to him/her via @mention on the Slicer Forum.
• [*] Permissive license is used for the main functions of the extension (recommended Apache or MIT). The extension can provide additional functionality in optional components that are distributed with non-permissive license, but the user has to explicitly approve those before using them (e.g., a pop-up can be displayed that explains the licensing terms and the user has to acknowledge them to proceed).
• All requirements of tiers < 3.

Tier 5

Critically important extensions, supported by Slicer core developers. New Slicer Stable Release is released only if all Tier 5 extension packages are successfully created on all supported platforms.

• [*] Slicer core developers accept the responsibility of fixing any issues caused by Slicer core changes; at least one Slicer core developer (anyone who has commit right to Slicer core) must be granted commit right to the extension's repository.
• [*] Automated tests for all critical features.
• [*] Maintainers respond to questions related to the extension on the Slicer Forum.
• All requirements of tiers < 5.

[Sirwan-Barichin]

Could you please provide more details regarding the specific error so that we can address and resolve it more accurately and effectively?

[Thibault-Pelletier]

Hi @MohammadRSalmanpour,

Your current PR doesn't use the right file format for extensions.

A JSON file is expected. You can have a look at one of the existing files in this repository for examples.

The CI should then provide more information on what is missing.

[MohammadRSalmanpour]

Hi, I just replaced the documents requested. Please don't hesitate to let me know if there are any issues that need to be resolved.

[MohammadRSalmanpour]

Meanwhile, should we have a new pull request, or will it go on our previous pull request?

[Sirwan-Barichin]

@lassoan ,@pieper
Hi,
Could you please provide more detailed guidance on how to correctly implement and register the PySERA extension in 3D Slicer?
We would greatly appreciate any clarification or additional instructions that can help us continue the development properly.
Thank you in advance for your support.

[MohammadRSalmanpour]

Hi @Thibault-Pelletier, we have changed the format for the extension and have also reviewed the JSON file. The test currently gives Lint/precommit(pull-request) failure. Can you please advise on what we need to do next? Thank you.

[Thibault-Pelletier]

Hi @MohammadRSalmanpour,

Pre-commit lint usually means that your file format doesn't match the hook (most of the time it's because of using tabs instead of spaces and other such related formats mismatch with expectation).

The easiest to fix is running pre-commit locally.

Pre-commit can be installed through any python environment using pip install pre-commit

You then install the pre-commit hook in the extension index folder using pre-commit install and finally run "pre-commit run --all-files"

This should modify the files that need reformatting and you can commit / them.

[lassoan]

Please fix the followings to allow packaging of the extension and loading of its modules:

• use LF as line ending in the json extension description file to make lint step pass
• pysera_lib is not packaged in the extension - either add it (under one of the module folders) or remove it if not needed
• PySera_Ext packaging fails because the icon that is specified in the CMakeLists.txt file is missing
• PySeraQt packaging fails because os missing icon - either fix this or remove the module if not needed
• remove all import pysera calls in module files at the file level, because the script will be attempted to be imported (and it will fail) before the script has a chance to call pip_install("pysera").
• squash all the commits