-
Notifications
You must be signed in to change notification settings - Fork 67
Create a repository mapping with descriptions for the project #1007
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.
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
Open
TimMonko
wants to merge
6
commits into
napari:main
Choose a base branch
from
TimMonko:docs/repo-map
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+165
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
fc536ef
add org wide repo map
TimMonko da75164
language improvement pass
TimMonko 514ba24
add to contributing index
TimMonko c5b925e
Apply suggestions from code review
TimMonko ef4563c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 341986f
update for present repo
TimMonko File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| (napari-repositories)= | ||
|
|
||
| # napari repository map | ||
|
|
||
| This page gives contributors a high-level map of the repositories in the | ||
| [napari GitHub organization](https://github.com/napari) and related projects. | ||
|
|
||
| The status labels are approximate and should be read as contributor guidance: | ||
|
|
||
| - **Active**: regular feature work or frequent cross-repository coordination. | ||
| We welcome contributors to these repositories to help drive forward new features and improvements. | ||
| Contributions to these repositories are likely to be more visible, but | ||
| may also require more coordination with the core team and other contributors. | ||
| - **Maintenance**: stable and useful; bug fixes, documentation updates, and | ||
| dependency work are usually the most common changes. | ||
| Contributions within this scope will be attended to in a timely manner, while | ||
| larger feature contributions may require more discussion and coordination to | ||
| ensure they fit with the current direction and scope of the project. | ||
| - **Early Development**: new or still changing quickly. Contributions are especially | ||
| welcome and can help shape the direction of these projects. These repositories | ||
| may be fast changing, but can be easier to contribute to since they have | ||
| fewer established conventions and patterns. | ||
| - **Backlog**: still relevant, but not a current priority for the core team. | ||
| We encourage contributions to these repos to bring them up to speed and | ||
| bring functionality to match the original vision for the project. | ||
|
|
||
| ## Core application and core plugins | ||
|
|
||
| These are the repositories that are most central to the core napari experience. | ||
| See [](upstream-dependencies) for libraries that are fundamental to napari functionality | ||
| but are developed outside of the napari organization. | ||
|
|
||
| | Repo | Description | Status | | ||
| | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | ----------- | | ||
| | [napari](https://github.com/napari/napari) | Main viewer application and the central repo for layers, events, settings, rendering integration, and releases. | **Active** | | ||
| | [napari-console](https://github.com/napari/napari-console) | In-viewer Python console plugin. | Maintenance | | ||
| | [napari-svg](https://github.com/napari/napari-svg) | SVG export plugin for napari layers. | Backlog | | ||
| | [napari-metadata](https://github.com/napari/napari-metadata) | Metadata editing plugin for layers; included with bundled installs and `napari[all]`. | Active | | ||
| | [bermuda](https://github.com/napari/bermuda) | Rust-backed spatial algorithms library used by napari for fast shape triangulation; included with `napari[all]`. | Maintenance | | ||
|
|
||
| ## Documentation, websites, and communication | ||
|
TimMonko marked this conversation as resolved.
|
||
|
|
||
| These repos shape how users and contributors discover napari, learn about it, | ||
| and interact with project resources online. These repositories are a great place to | ||
| contribute, even if you don't have experience with Python, since they mostly involve | ||
| writing and design. | ||
|
|
||
| ### Core website | ||
|
|
||
| These repos build and publish the main napari.org site. | ||
|
|
||
| | Repo | Description | Status | | ||
| | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ----------- | | ||
| | [docs](https://github.com/napari/docs) | Main narrative documentation sources for napari.org, excluding most autogenerated API docs. | Active | | ||
| | [napari-sphinx-theme](https://github.com/napari/napari-sphinx-theme) | Shared Sphinx theme and site UI used across napari websites. | Active | | ||
| | [napari.github.io](https://github.com/napari/napari.github.io) | Website content and generated assets used to publish napari/docs on napari.org. | Maintenance | | ||
| | [resources](https://github.com/napari/resources) | Shared graphics, copy, and brand resources for the project. | Maintenance | | ||
|
|
||
| ### Additional websites and pages | ||
|
|
||
| Sibling sites and community-facing pages published alongside the main docs. | ||
|
|
||
| | Repo | Description | Status | | ||
| | ------------------------------------------------------------ | ------------------------------------------------------------------------------ | ----------- | | ||
| | [workshops](https://github.com/napari/workshops) | Current workshop materials and publishing infrastructure for napari workshops. | Active | | ||
| | [island-dispatch](https://github.com/napari/island-dispatch) | Blog for napari news, announcements, and community updates. | Active | | ||
| | [weather-report](https://github.com/napari/weather-report) | Public analytics dashboard for project and ecosystem metrics. | Maintenance | | ||
| | [meeting-notes](https://github.com/napari/meeting-notes) | Notes from recurring project meetings. | Active | | ||
| | [surveys](https://github.com/napari/surveys) | Analysis workflows for napari survey data. | Active | | ||
|
|
||
| ## Plugin system | ||
|
|
||
| The plugin ecosystem is built around the `npe2` plugin engine and manifest specification. | ||
| The repositories below are focused on supporting the plugin ecosystem, | ||
| whether through core plugin infrastructure or development resources. | ||
|
|
||
| | Repo | Description | Status | | ||
| | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ------- | | ||
| | [npe2](https://github.com/napari/npe2) | Plugin manifest and engine v2 for the napari plugin ecosystem. | Active | | ||
| | [napari-plugin-manager](https://github.com/napari/napari-plugin-manager) | Graphical plugin installer and management UI inside the viewer. | Active | | ||
| | [napari-plugin-template](https://github.com/napari/napari-plugin-template) | Main template for creating new napari plugins. | Active | | ||
| | [npe2api](https://github.com/napari/npe2api) | API documentation and schema reference site for the npe2 plugin manifest system. | Active | | ||
| | [hub-lite](https://github.com/napari/hub-lite) | Static implementation of the napari plugin hub website. | Active | | ||
| | [napari-plugin-checks](https://github.com/napari/napari-plugin-checks) | Checks and helper tooling for validating napari plugins. | Backlog | | ||
|
|
||
| ## Specialized plugins | ||
|
|
||
| These repos are useful to contributors working on particular workflows or newer | ||
| features, but they are not as central as the core application and docs repos. | ||
|
|
||
| | Repo | Description | Status | | ||
| | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------- | | ||
| | [napari-animation](https://github.com/napari/napari-animation) | Plugin for building and exporting animations from viewer state. | Active | | ||
| | [napari-geojson](https://github.com/napari/napari-geojson) | GeoJSON support for reading and writing geographic annotation data in napari. | Active | | ||
| | [napari-graph](https://github.com/napari/napari-graph) | Graph data structures and algorithms for visualization and editing workflows. | Backlog | | ||
| | [napari-tiff](https://github.com/napari/napari-tiff) | TIFF reader and writer plugin maintained by the napari team. | Active | | ||
| | [midi-app-controller](https://github.com/napari/midi-app-controller) | MIDI controller integration for driving the napari UI. | Maintenance | | ||
| | [update-checker](https://github.com/napari/update-checker) | Viewer extension for checking whether a bundled napari app has an available update. | Backlog | | ||
|
|
||
| ## Release, packaging, and ecosystem tooling | ||
|
|
||
| These repos support packaging, automation, and other project-level operations. | ||
|
|
||
| | Repo | Description | Status | | ||
| | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ----------- | | ||
| | [packaging](https://github.com/napari/packaging) | Build and packaging infrastructure for bundled installers and app distribution. | Maintenance | | ||
| | [napari-release-tools](https://github.com/napari/napari-release-tools) | Scripts and automation used to streamline the release process. | Active | | ||
| | [shared-workflows](https://github.com/napari/shared-workflows) | Reusable GitHub Actions workflows shared across napari repositories. | Active | | ||
| | [pins](https://github.com/napari/pins) | Version constraints and compatibility pins for the napari plugin ecosystem. | Backlog | | ||
| | [constructor-manager](https://github.com/napari/constructor-manager) | Tooling related to managing constructor-based app bundles. | Backlog | | ||
|
|
||
| (upstream-dependencies)= | ||
|
|
||
| ## Important upstream dependencies | ||
|
|
||
| The repositories below are not in the `napari` GitHub organization, but they | ||
| are important friends of napari that are contributed to by members of the napari community. | ||
|
|
||
| - [vispy/vispy](https://github.com/vispy/vispy): rendering backend and canvas | ||
| infrastructure used by napari. | ||
|
|
||
| The following `pyapp-kit` projects are developed in close coordination with | ||
| napari's needs: | ||
|
|
||
| - [pyapp-kit/magicgui](https://github.com/pyapp-kit/magicgui): automatic widget | ||
| generation from Python type hints, widely used in plugins and some napari UI. | ||
| - [pyapp-kit/superqt](https://github.com/pyapp-kit/superqt): extended Qt widgets | ||
| used by napari and related plugins. | ||
| - [pyapp-kit/app-model](https://github.com/pyapp-kit/app-model): action and | ||
| command model used by modern napari UI infrastructure; originally developed | ||
| in the napari organization. | ||
| - [pyapp-kit/psygnal](https://github.com/pyapp-kit/psygnal): typed event and | ||
| signal system used across the pyapp-kit and napari ecosystem; its evented | ||
| containers and models were spun out of code originally written for napari. | ||
|
|
||
| ```{dropdown} Archived and historical repositories | ||
|
|
||
| Archived repositories are included here for completeness. In most cases, new | ||
| work should start in a different repository. | ||
|
|
||
| - [cookiecutter-napari-plugin](https://github.com/napari/cookiecutter-napari-plugin): predecessor to `napari-plugin-template`. | ||
| - [dummy-test-plugin](https://github.com/napari/dummy-test-plugin): testing plugin used for plugin-system development. | ||
| - [image-types](https://github.com/napari/image-types): type-definition experiment for image-oriented Python code. | ||
| - [jupyterlab-bot](https://github.com/napari/jupyterlab-bot): historical fork. | ||
| - [magicgui](https://github.com/napari/magicgui): mirror of the upstream `pyapp-kit/magicgui` project. | ||
| - [napari-core](https://github.com/napari/napari-core): early core repository from before the current `napari` layout. | ||
| - [napari-data](https://github.com/napari/napari-data): example-data repository. | ||
| - [napari-hello-world](https://github.com/napari/napari-hello-world): example plugin repository. | ||
| - [napari-io](https://github.com/napari/napari-io): early IO plugin repository. | ||
| - [napari-language-packs](https://github.com/napari/napari-language-packs): repository for downloadable language packs for the napari UI. | ||
| - [napari-plugin-devtools](https://github.com/napari/napari-plugin-devtools): tooling repo for plugin developers. | ||
| - [napari-plugin-engine](https://github.com/napari/napari-plugin-engine): legacy plugin engine based on pluggy. | ||
| - [napari-scipy2025-workshop](https://github.com/napari/napari-scipy2025-workshop): workshop-specific repository for the SciPy 2025 napari tutorial materials. | ||
| - [napari-web-experimental](https://github.com/napari/napari-web-experimental): archived exploration of a possible web front end. | ||
| - [napari-workshop-template](https://github.com/napari/napari-workshop-template): template for creating napari workshop websites and materials. | ||
| - [napari-xarray](https://github.com/napari/napari-xarray): integration work for xarray-based data and labeled nD arrays in napari. Now in core napari. | ||
| - [old-docs](https://github.com/napari/old-docs): documentation repository from an older docs system. | ||
| - [plugin-cookiecutter](https://github.com/napari/plugin-cookiecutter): early plugin cookiecutter repository. | ||
| - [product-heuristics-2020](https://github.com/napari/product-heuristics-2020): product-heuristics snapshot from 2020. | ||
| - [superqt](https://github.com/napari/superqt): mirror of the upstream `pyapp-kit/superqt` project. | ||
|
|
||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.