boilerplate

Author: benbovy

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+files: 'xdggs\/'
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.2
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+ci:
+  autofix_prs: false
+  autoupdate_schedule: quarterly

environment.yml

@@ -0,0 +1,9 @@
+name: xdggs_dev
+channels:
+  - conda-forge
+dependencies:
+  - xarray
+  - h3
+  - healpy
+  - ruff
+  - pytest

pyproject.toml

@@ -0,0 +1,84 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+
+[tool.setuptools.packages.find]
+include = [
+    "xdggs",
+    "xdggs.*",
+]
+
+[project]
+name = "xdggs"
+dynamic = ["version"]
+authors = [
+    {name = "Benoît Bovy"},
+    {name = "Justus Magin"},
+]
+maintainers = [
+    {name = "xdggs contributors"},
+]
+license = {text = "Apache-2.0"}
+description = "Xarray extension for DGGS"
+keywords = ["DGGS", "xarray", "GIS"]
+readme = "Readme.md"
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: GIS",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "xarray",
+    "healpy",
+    "h3",
+]
+
+[project.urls]
+# Home = "https://xdggs.readthedocs.io"
+Repository = "https://github.com/benbovy/xdggs"
+
+[tool.ruff]
+target-version = "py311"
+builtins = ["ellipsis"]
+exclude = [
+    ".git",
+    ".eggs",
+    "build",
+    "dist",
+    "__pycache__",
+]
+# E402: module level import not at top of file
+# E501: line too long - let black worry about that
+# E731: do not assign a lambda expression, use a def
+ignore = [
+    "E402",
+    "E501",
+    "E731",
+]
+select = [
+    # Pyflakes
+    "F",
+    # Pycodestyle
+    "E",
+    "W",
+    # isort
+    "I",
+    # Pyupgrade
+    "UP",
+]
+
+[tool.ruff.isort]
+known-first-party = ["xdggs"]
+known-third-party=[
+    "xarray",
+    "healpy",
+    "h3",
+]
+
+[tool.ruff.format]
+line-length = 100

xdggs/__init__.py

@@ -1,7 +1,14 @@
-from .accessor import DGGSAccessor
+from importlib.metadata import PackageNotFoundError, version
+
+from .accessor import DGGSAccessor   # noqa
 from .index import DGGSIndex
 from .healpix import HealpixIndex
 
-__all__ = ["DGGSIndex", "HealpixIndex"]
 
-__version__ = "0.0.1"
+try:
+    __version__ = version("xdggs")
+except PackageNotFoundError:  # noqa
+    # package is not installed
+    pass
+
+__all__ = ["__version__", "DGGSIndex", "HealpixIndex"]