diff --git a/README.md b/README.md index 055ec20..9688e08 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # portal-visualization Given HuBMAP Dataset JSON, creates a Vitessce configuration. -Included as a submodule in [portal-ui](https://github.com/hubmapconsortium/portal-ui). +Included as a python package in [portal-ui](https://github.com/hubmapconsortium/portal-ui): +If there are updates here that need to be visible there: +- bump `VERSION.txt`. +- make a new git tag: `V=$(cat VERSION.txt); git tag $V; git push origin $V`. +- update portal-ui `requirements.txt`. ## Background diff --git a/VERSION.txt b/VERSION.txt new file mode 100644 index 0000000..8a9ecc2 --- /dev/null +++ b/VERSION.txt @@ -0,0 +1 @@ +0.0.1 \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..fa7093a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools>=42"] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 55fd98b..8ff01ce 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,2 @@ -vitessce==1.0.5 -hubmap-commons==2.0.12 -requests==2.27.1 -nbformat==5.1.3 \ No newline at end of file +. +# Specified in setup.cfg \ No newline at end of file diff --git a/setup.cfg b/setup.cfg index fd4edb0..b95b459 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,3 +1,31 @@ +[metadata] +name = portal-visualization +version = file: VERSION.txt +author = Chuck McCallum +author_email = mccallucc@gmail.com +description = Given HuBMAP Dataset JSON, creates a Vitessce configuration. +long_description = file: README.md +long_description_content_type = text/markdown +url = https://github.com/hubmapconsortium/portal-visualization +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: MIT License + Operating System :: OS Independent + +[options] +package_dir = + = src +packages = find: +python_requires = >=3.6 +install_requires = + vitessce==1.0.5 + hubmap-commons>=2.0.12 + requests>=2.27.1 + nbformat==5.1.3 + +[options.packages.find] +where = src + [flake8] max-line-length = 99 ignore = diff --git a/src/__init__.py b/src/portal_visualization/__init__.py similarity index 100% rename from src/__init__.py rename to src/portal_visualization/__init__.py diff --git a/src/assays.py b/src/portal_visualization/assays.py similarity index 100% rename from src/assays.py rename to src/portal_visualization/assays.py diff --git a/src/builder_factory.py b/src/portal_visualization/builder_factory.py similarity index 100% rename from src/builder_factory.py rename to src/portal_visualization/builder_factory.py diff --git a/src/builders/__init__.py b/src/portal_visualization/builders/__init__.py similarity index 100% rename from src/builders/__init__.py rename to src/portal_visualization/builders/__init__.py diff --git a/src/builders/anndata_builders.py b/src/portal_visualization/builders/anndata_builders.py similarity index 100% rename from src/builders/anndata_builders.py rename to src/portal_visualization/builders/anndata_builders.py diff --git a/src/builders/base_builders.py b/src/portal_visualization/builders/base_builders.py similarity index 100% rename from src/builders/base_builders.py rename to src/portal_visualization/builders/base_builders.py diff --git a/src/builders/imaging_builders.py b/src/portal_visualization/builders/imaging_builders.py similarity index 100% rename from src/builders/imaging_builders.py rename to src/portal_visualization/builders/imaging_builders.py diff --git a/src/builders/scatterplot_builders.py b/src/portal_visualization/builders/scatterplot_builders.py similarity index 100% rename from src/builders/scatterplot_builders.py rename to src/portal_visualization/builders/scatterplot_builders.py diff --git a/src/builders/sprm_builders.py b/src/portal_visualization/builders/sprm_builders.py similarity index 100% rename from src/builders/sprm_builders.py rename to src/portal_visualization/builders/sprm_builders.py diff --git a/src/paths.py b/src/portal_visualization/paths.py similarity index 100% rename from src/paths.py rename to src/portal_visualization/paths.py diff --git a/src/utils.py b/src/portal_visualization/utils.py similarity index 100% rename from src/utils.py rename to src/portal_visualization/utils.py diff --git a/test/test_builders.py b/test/test_builders.py index 29c620a..6654550 100644 --- a/test/test_builders.py +++ b/test/test_builders.py @@ -10,7 +10,7 @@ from hubmap_commons.type_client import TypeClient -from src.builder_factory import get_view_config_builder, has_visualization +from src.portal_visualization.builder_factory import get_view_config_builder, has_visualization @dataclass