Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docs about the new napari-base structure #457

Merged
merged 2 commits into from
Jul 19, 2024
Merged

Add docs about the new napari-base structure #457

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2146ed2
Add docs about the new `napari-base` structure
jaimergp Jul 16, 2024
2adb9bf
Update docs/developers/coredev/packaging.md
jaimergp Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/developers/coredev/packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This is all automated by the `conda-forge` infrastructure (see [previous example
We only need to check that the metadata in the recipe has been adjusted for the new release.
Pay special attention to the runtime dependencies and version strings!

> We keep a copy of the feedstock's recipe in the `napari/packaging` repo, which is updated manually whenever a change to `setup.cfg` is detected.
> We keep a copy of the feedstock's recipe in the `napari/packaging` repo, which is updated manually whenever a change to `pyproject.toml` is detected.
> Check the file `conda-recipe/meta.yaml` and make sure its `outputs` contents are synced to the `napari-feedstock` copy.
Once the conda-forge CI is passing and the PR is approved and merged, the final packages will be built on the default branch and uploaded to the `conda-forge` channel.
Expand All @@ -36,6 +36,22 @@ Due to the staging steps and CDN synchronization delays, the conda packages can
Check {doc}`release` for more details about the conda-forge release process and maintenance tasks.
```

#### conda packaging split

We provide three different outputs in the conda package recipe:

- `napari-base`: This is the package that ships the actual source and data. The runtime
requirements only include the basic functionality. This package is recommended as a
dependency for plugins and other projects. Most end users will prefer the `napari`
package, below, but this one may be useful for those wanting a more minimal
environment.
- `napari`: This output is what most users want. It depends on `napari-base`, and adds optional yet
recommended dependencies for (performant) GUI usage, like the plugin manager or numba. Note that
the Qt backend is _not_ included.
- `napari-menu`: Depends on `napari`, and ships the menuinst JSON file, in case you want a desktop
shortcut to start the application easily. This is included as part of the bundled installers for
convenience.

### conda packages in the `napari` channel

The `napari` project also has a `napari` channel in anaconda.org.
Expand Down
Loading