Skip to content

qupath/extension-catalog-model

Repository files navigation

Extension catalog model

Coverage Tests Actions

This is a pydantic package for creating, validating and writing JSON files for the QuPath extension manager project.

Check out the documentation for guidance on creating a catalog.

To create a catalog:

from extension_catalog_model.model import *

version_range = VersionRange(min="v0.5.1")
release = Release(
    name="v0.1.0-rc5",
    main_url="https://github.com/qupath/qupath-extension-omero/releases/download/v0.1.0-rc5/qupath-extension-omero-0.1.0-rc5.jar",
    optional_dependency_urls=["https://github.com/ome/openmicroscopy/releases/download/v5.6.14/OMERO.java-5.6.14-ice36.zip"],
    version_range=version_range
)
extension = Extension(
    name="QuPath OMERO extension",
    description="QuPath extension to work with images through OMERO's APIs",
    author="QuPath",
    homepage="https://github.com/qupath/qupath-extension-omero",
    releases=[release]
)
catalog = Catalog(
    name="QuPath catalog",
    description="Extensions maintained by the QuPath team",
    extensions=[extension]
)

To read a catalog from a JSON file:

from extension_catalog_model.model import Catalog
Catalog.parse_file("catalog.json")

An example can be found on the QuPath catalog repository.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •