setup.py -> pyproject.toml

.copier-answers.yml

@@ -0,0 +1,12 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: dfb0404
+_src_path: https://github.com/qiime2/q2-setup-template.git
+module_name: sapienns
+plugin_name: q2_sapienns
+plugin_scripts: null
+project_author_email: greg.caporaso@nau.edu
+project_author_name: Greg Caporaso
+project_description: null
+project_name: q2-sapienns
+project_urls_homepage: https://github.com/gregcaporaso/q2-sapienns
+project_urls_repository: https://github.com/caporaso-lab/q2-sapienns

.gitattributes

@@ -1 +1 @@
-q2_sapienns/_version.py export-subst
+pyproject.toml export-subst

.github/workflows/ci-dev.yaml

@@ -9,4 +9,5 @@ jobs:
   ci:
     uses: qiime2/distributions/.github/workflows/lib-ci-dev.yaml@dev
     with:
-      distro: shotgun
+      distro: metagenome
+      recipe-path: 'conda-recipe'

.gitignore

@@ -158,3 +158,7 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Version file from versioningit
+_version.py
+

Makefile

@@ -15,7 +15,7 @@ test-cov: all
 	py.test --cov=q2_sapienns
 
 install: all
-	$(PYTHON) setup.py install
+	$(PYTHON) -m pip install -v .
 
 dev: all
 	pip install -e .

README.md

@@ -2,7 +2,7 @@
 
 q2-sapienns is a set of tools that can be used for preparing [BioBakery3](https://doi.org/10.7554/eLife.65088) data for use in [QIIME 2](https://qiime2.org). As QIIME 2 expands support for metagenomics data analysis, this will provide a framework for working with processed BioBakery3 data, and for comparing other methods to BioBakery3.
 
-**q2-sapienns is now included in the alpha QIIME 2 shotgun distribution, and this is the best way to install and use it.**
+**q2-sapienns is now included in the alpha QIIME 2 metagenome distribution, and this is the best way to install and use it.**
 
 Basic usage examples are provided below.
 
@@ -12,9 +12,9 @@ Please feel free to post questions to the [QIIME 2 Forum](https://forum.qiime2.o
 
 ## Installation
 
-### QIIME 2 Shotgun Distribution
+### QIIME 2 Metagenome Distribution
 
-q2-sapienns is included in the QIIME 2 shotgun distribution. To find install instructions, see *Installing QIIME 2* at https://docs.qiime2.org.
+q2-sapienns is included in the QIIME 2 metagenome distribution. To find install instructions, see *Installing QIIME 2* at https://docs.qiime2.org.
 
 ### Install in other QIIME 2 environments (experts only!)
 

conda-recipe/meta.yaml

@@ -0,0 +1,33 @@
+package:
+  name: q2-sapienns
+  version: {{ PLUGIN_VERSION }}
+source:
+  path: ..
+build:
+  script: make install
+requirements:
+  host:
+  - python {{ python }}
+  - setuptools
+  - versioningit
+  - wheel
+  run:
+  - python {{ python }}
+  - pandas {{ pandas }}
+  - qiime2 {{ qiime2_epoch }}.*
+  - q2-types {{ qiime2_epoch }}.*
+  build:
+  - setuptools
+  - versioningit
+test:
+  requires:
+  - qiime2 >={{ qiime2 }}
+  - q2-types >={{ q2_types }}
+  - pytest
+  imports:
+  - q2_sapienns
+  - qiime2.plugins.sapienns
+about:
+  home: https://github.com/gregcaporaso/q2-sapienns
+  license: BSD-3-Clause
+  license_family: BSD

pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "q2-sapienns"
+authors = [
+    { name = "Greg Caporaso", email = "greg.caporaso@nau.edu" }
+]
+description = "None"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE"}
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/gregcaporaso/q2-sapienns"
+Repository = "https://github.com/caporaso-lab/q2-sapienns"
+
+[project.entry-points.'qiime2.plugins']
+"q2-sapienns" = "q2_sapienns.plugin_setup:plugin"
+
+[build-system]
+requires = [
+    "setuptools",
+    "versioningit",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.versioningit.vcs]
+method = "git-archive"
+describe-subst = "$Format:%(describe)$"
+default-tag = "0.0.1"
+
+[tool.versioningit.next-version]
+method = "minor"
+
+[tool.versioningit.format]
+distance = "{base_version}+{distance}.{vcs}{rev}"
+dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+
+[tool.versioningit.write]
+file = "q2-sapienns/_version.py"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["q2_sapienns*"]
+
+[tool.setuptools.package-data]
+q2_sapienns = ["**/*"]

q2_sapienns/__init__.py

@@ -8,8 +8,10 @@
 
 # flake8: noqa
 
-from . import _version
-__version__ = _version.get_versions()['version']
+try:
+    from ._version import __version__
+except ModuleNotFoundError:
+    __version__ = '0.0.0+notfound'
 
 from .plugin_setup import (
     HumannGeneFamilyDirectoryFormat, HumannGeneFamilyFormat,