From 37fb6fa761e699481236c786622fa6b4ad5b45ee Mon Sep 17 00:00:00 2001 From: Genevieve Buckley <30920819+GenevieveBuckley@users.noreply.github.com> Date: Wed, 14 Feb 2024 16:31:19 +1100 Subject: [PATCH] Rename from napari-tifffile-reader to napari-tiff (for future addition of writer plugins, etc.) --- LICENSE | 2 +- README.md | 20 +++++++++---------- docs/index.md | 2 +- mkdocs.yml | 4 ++-- .../__init__.py | 2 +- .../_tests/__init__.py | 0 .../_tests/test_tiff_reader.py | 10 +++++----- .../napari_tiff_reader.py | 0 setup.py | 8 ++++---- 9 files changed, 24 insertions(+), 24 deletions(-) rename {napari_tifffile_reader => napari_tiff}/__init__.py (76%) rename {napari_tifffile_reader => napari_tiff}/_tests/__init__.py (100%) rename napari_tifffile_reader/_tests/test_tifffile_reader.py => napari_tiff/_tests/test_tiff_reader.py (91%) rename napari_tifffile_reader/napari_tifffile_reader.py => napari_tiff/napari_tiff_reader.py (100%) diff --git a/LICENSE b/LICENSE index ce4d28b..1e9e8de 100644 --- a/LICENSE +++ b/LICENSE @@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met: this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of napari-tifffile-reader nor the names of its +* Neither the name of napari-tiff nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 3361072..634a60b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# napari-tifffile-reader +# napari-tiff -[![License](https://img.shields.io/pypi/l/napari-tifffile-reader.svg?color=green)](https://github.com/napari/napari-tifffile-reader/raw/master/LICENSE) -[![PyPI](https://img.shields.io/pypi/v/napari-tifffile-reader.svg?color=green)](https://pypi.org/project/napari-tifffile-reader) -[![Python Version](https://img.shields.io/pypi/pyversions/napari-tifffile-reader.svg?color=green)](https://python.org) -[![tests](https://github.com/GenevieveBuckley/napari-tifffile-reader/workflows/tests/badge.svg)](https://github.com/GenevieveBuckley/napari-tifffile-reader/actions) -[![codecov](https://codecov.io/gh/GenevieveBuckley/napari-tifffile-reader/branch/master/graph/badge.svg)](https://codecov.io/gh/GenevieveBuckley/napari-tifffile-reader) +[![License](https://img.shields.io/pypi/l/napari-tiff.svg?color=green)](https://github.com/napari/napari-tiff/raw/master/LICENSE) +[![PyPI](https://img.shields.io/pypi/v/napari-tiff.svg?color=green)](https://pypi.org/project/napari-tiff) +[![Python Version](https://img.shields.io/pypi/pyversions/napari-tiff.svg?color=green)](https://python.org) +[![tests](https://github.com/GenevieveBuckley/napari-tiff/workflows/tests/badge.svg)](https://github.com/GenevieveBuckley/napari-tiff/actions) +[![codecov](https://codecov.io/gh/GenevieveBuckley/napari-tiff/branch/master/graph/badge.svg)](https://codecov.io/gh/GenevieveBuckley/napari-tiff) A napari plugin for tiff images. @@ -22,9 +22,9 @@ https://napari.org/docs/plugins/index.html ## Installation -You can install `napari-tifffile-reader` via [pip]: +You can install `napari-tiff` via [pip]: - pip install napari-tifffile-reader + pip install napari-tiff ## Contributing @@ -34,7 +34,7 @@ the coverage at least stays the same before you submit a pull request. ## License Distributed under the terms of the [BSD-3] license, -"napari-tifffile-reader" is free and open source software +"napari-tiff" is free and open source software ## Issues @@ -50,7 +50,7 @@ If you encounter any problems, please [file an issue] along with a detailed desc [Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0 [Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt [cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin -[file an issue]: https://github.com/GenevieveBuckley/napari-tifffile-reader/issues +[file an issue]: https://github.com/GenevieveBuckley/napari-tiff/issues [napari]: https://github.com/napari/napari [tox]: https://tox.readthedocs.io/en/latest/ [pip]: https://pypi.org/project/pip/ diff --git a/docs/index.md b/docs/index.md index 973d4a2..c6e2070 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,3 @@ -# Welcome to napari-tifffile-reader +# Welcome to napari-tiff A napari plugin for tiff images. diff --git a/mkdocs.yml b/mkdocs.yml index 416f4ac..5ad35ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,10 @@ -site_name: napari-tifffile-reader +site_name: napari-tiff site_description: A napari plugin for tiff images. site_author: Genevieve Buckley theme: readthedocs -repo_url: https://github.com/GenevieveBuckley/napari-tifffile-reader +repo_url: https://github.com/GenevieveBuckley/napari-tiff pages: - Home: index.md diff --git a/napari_tifffile_reader/__init__.py b/napari_tiff/__init__.py similarity index 76% rename from napari_tifffile_reader/__init__.py rename to napari_tiff/__init__.py index 0743937..1ac1555 100644 --- a/napari_tifffile_reader/__init__.py +++ b/napari_tiff/__init__.py @@ -4,7 +4,7 @@ __version__ = "unknown" # replace the asterisk with named imports -from .napari_tifffile_reader import napari_get_reader +from .napari_tiff_reader import napari_get_reader __all__ = ["napari_get_reader"] diff --git a/napari_tifffile_reader/_tests/__init__.py b/napari_tiff/_tests/__init__.py similarity index 100% rename from napari_tifffile_reader/_tests/__init__.py rename to napari_tiff/_tests/__init__.py diff --git a/napari_tifffile_reader/_tests/test_tifffile_reader.py b/napari_tiff/_tests/test_tiff_reader.py similarity index 91% rename from napari_tifffile_reader/_tests/test_tifffile_reader.py rename to napari_tiff/_tests/test_tiff_reader.py index 02d42e4..d81ddca 100644 --- a/napari_tifffile_reader/_tests/test_tifffile_reader.py +++ b/napari_tiff/_tests/test_tiff_reader.py @@ -2,11 +2,11 @@ import zipfile import numpy as np -from napari_tifffile_reader import napari_get_reader -from napari_tifffile_reader.napari_tifffile_reader import (imagecodecs_reader, - imagej_reader, - tifffile_reader, - zip_reader) +from napari_tiff import napari_get_reader +from napari_tiff.napari_tiff_reader import (imagecodecs_reader, + imagej_reader, + tifffile_reader, + zip_reader) import pytest import tifffile diff --git a/napari_tifffile_reader/napari_tifffile_reader.py b/napari_tiff/napari_tiff_reader.py similarity index 100% rename from napari_tifffile_reader/napari_tifffile_reader.py rename to napari_tiff/napari_tiff_reader.py diff --git a/setup.py b/setup.py index 4ce2c16..3558ac5 100644 --- a/setup.py +++ b/setup.py @@ -22,13 +22,13 @@ def read(fname): # https://github.com/pypa/setuptools_scm -use_scm = {"write_to": "napari_tifffile_reader/_version.py"} +use_scm = {"write_to": "napari_tiff/_version.py"} setup( - name='napari-tifffile-reader', + name='napari-tiff', author='Genevieve Buckley', license='BSD-3', - url='https://github.com/GenevieveBuckley/napari-tifffile-reader', + url='https://github.com/GenevieveBuckley/napari-tiff', description='A napari reader plugin for tiff images.', long_description=read('README.md'), long_description_content_type='text/markdown', @@ -53,7 +53,7 @@ def read(fname): ], entry_points={ 'napari.plugin': [ - 'tifffile = napari_tifffile_reader', + 'tifffile = napari_tiff', ], }, )