When you first run the template to build a napari plugin, you will be prompted
Sign in to like and favorite skills
When you first run the template to build a napari plugin, you will be prompted for some configuration options. Your answers to these prompts will determine some aspects of your plugin package including its name, versioning behaviour, license, etc. None of these configuration options are set in stone - you can always change these later, but it may require some effort.
This document details what each of the prompts is asking, what the effect of your choice will be on your package directory/plugin, and any potential pitfalls of selecting one option over another.
**Note: ** Many of these configuration options will also affect how your plugin appears on the napari hub. If you're planning on publishing your plugin to PyPI (and by extension, the hub), you can refer to this document for detailed documentation on customizing your listing.
This is the name of the main author of this plugin, and will appear in your
pyproject.tomlThis is your preferred contact email address and will appear in your
pyproject.tomlThis is the GitHub username under whose account the GitHub repository for the plugin will be hosted. This username will be used to create the GitHub url for this plugin and will appear as part of the
urlpyproject.tomlThis username could be your personal username or the organization under which you plan to host the plugin on GitHub. If you do not wish to provide a username, simply press
Enterprovide latergithub_repository_urlurlpyproject.tomlThis is the desired name for your napari plugin, and will also be the name of the Python package directory we create for you. The plugin name you choose will be listed in
pyproject.tomlname[options.entry_points]pip install plugin_name
The convention for these packages is that they should have short, all-lowercase names, with hyphens preferred over underscores for separating words. Note that for user-facing text, napari and the napari hub will use the
display_nameThis will be the code repository link that is stored in the
urlpyproject.tomlgithub_username_or_organizationplugin_nameChoose
provide laterpyproject.tomlurlThis is the name of the Python module where the code for your plugin will live. We create a folder with this name inside the top level directory of your plugin, and populate it with code templates.
This module will also be added as the entry point to your plugin in
pyproject.tomlUser-facing text to display as the name of this plugin. For example, this will be used in the napari plugin menu and in the napari File > Open Sample menu, as well as by the napari hub. It should be 3-40 characters long. It will be listed in
napari.yamldisplay_nameThis should be a short description of what your plugin does. It will be listed in
pyproject.tomldescriptionChoosing
"y"_reader.pyChoosing
"y"_writer.pyChoosing
"y"_sample_data.pyChoosing
"y"_widget.pyThe default for this prompt is
"y"If you choose "y" for this prompt, then pre-commit will be installed. Among other things, it includes checks for code linting and best practices in napari plugins.
The default for this prompt is
"y"If you choose "y" for this prompt, then a Dependabot configuration file will be created at
.github/dependabot.ymlYou will still need to enable Dependabot in your github settings, see the instructions at this link.
This prompt allows you to choose from a variety of open source licensing options for your plugin. Choosing any of the options will lead to a boilerplate
LICENSEpyproject.tomllicenseLicense options include: BSD-3, MIT, MPL v2.0, Apache v2.0, GNU GPL v3.0, or GNU LGPL v3.0