Merge pull request #2 from astropenguin/#1-dataarrayclass

Add class decorator

Author: astropenguin

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203

.github/workflows/publish.yml

@@ -21,3 +21,24 @@ jobs:
           pip install poetry
           poetry build
           poetry publish --username $USERNAME --password $PASSWORD
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Build docs
+        run: |
+          pip install poetry
+          poetry install
+          poetry run sphinx-apidoc -f -o docs/_apidoc xarray_custom
+          poetry run sphinx-build docs docs/_build
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ secrets.PERSONAL_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./docs/_build
+          force_orphan: true

.gitignore

@@ -1,6 +1,10 @@
 # Editor settings
 .vscode/
 
+# Sphinx docs
+docs/_build
+docs/_apidoc
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -1,2 +1,40 @@
 # xarray-custom
+
+[![PyPI](https://img.shields.io/pypi/v/xarray-custom.svg?label=PyPI&style=flat-square)](https://pypi.org/pypi/xarray-custom/)
+[![Python](https://img.shields.io/pypi/pyversions/xarray-custom.svg?label=Python&color=yellow&style=flat-square)](https://pypi.org/pypi/xarray-custom/)
+[![Test](https://img.shields.io/github/workflow/status/astropenguin/xarray-custom/Test?logo=github&label=Test&style=flat-square)](https://github.com/astropenguin/xarray-custom/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?label=License&style=flat-square)](LICENSE)
+
 :zap: Data classes for custom xarray constructors
+
+## TL;DR
+
+xarray-custom is a Python package which helps to create custom DataArray classes in the same manner as [the Python's native dataclass](https://docs.python.org/3/library/dataclasses.html).
+Here is an introduction code of what the package provides:
+
+```python
+from xarray_custom import coordtype, dataarrayclass
+
+
+@dataarrayclass(('x', 'y'), float, 'custom')
+class CustomDataArray:
+    x: coordtype('x', int)
+    y: coordtype('y', int)
+    z: coordtype(('x', 'y'), str) = 'spam'
+
+    def double(self):
+        """Custom DataArray method which doubles values."""
+        return self * 2
+
+
+dataarray = CustomDataArray([[0, 1], [2, 3]], x=[2, 2], y=[3, 3])
+onesarray = CustomDataArray.ones(shape=(3, 3))
+doubled = dataarray.custom.double()
+```
+
+The key points are:
+
+- Custom DataArray instances with fixed dimensions and coordinates can easily be created.
+- Default values and dtype can be specified via a class decorator and class variable annotations.
+- NumPy-like special factory functions like ``ones()`` are provided as class methods.
+- Custom DataArray methods can be used via a custom accessor.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/dataset-diagram-logo.png

@@ -0,0 +1,65 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "xarray-custom"
+copyright = "2020, Akio Taniguchi"
+author = "Akio Taniguchi"
+
+# The full version, including alpha/beta/rc tags
+release = "0.2.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "pydata_sphinx_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+
+# Options added by the author
+html_logo = "_static/dataset-diagram-logo.png"
+html_theme_options = {"github_url": "https://github.com/astropenguin/xarray-custom"}

docs/conf.py

@@ -0,0 +1,47 @@
+.. xarray-custom documentation master file, created by
+   sphinx-quickstart on Sat May  9 22:13:03 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+xarray-custom documentation
+=============================
+
+**Date**: |today| **Version**: |release|
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+xarray-custom is a Python package which helps to create custom DataArray classes in the same manner as `the Python's native dataclass <https://docs.python.org/3/library/dataclasses.html>`__.
+Here is an introduction code of what the package provides::
+
+    from xarray_custom import coordtype, dataarrayclass
+
+
+    @dataarrayclass(('x', 'y'), float, 'custom')
+    class CustomDataArray:
+        x: coordtype('x', int)
+        y: coordtype('y', int)
+        z: coordtype(('x', 'y'), str) = 'spam'
+
+        def double(self):
+            """Custom DataArray method which doubles values."""
+            return self * 2
+
+
+    dataarray = CustomDataArray([[0, 1], [2, 3]], x=[2, 2], y=[3, 3])
+    onesarray = CustomDataArray.ones(shape=(3, 3))
+    doubled = dataarray.custom.double()
+
+The key points are:
+
+* Custom DataArray instances with fixed dimensions and coordinates can easily be created.
+* Default values and dtype can be specified via a class decorator and class variable annotations.
+* NumPy-like special factory functions like ``ones()`` are provided as class methods.
+* Custom DataArray methods can be used via a custom accessor.
+
+Contents
+========
+
+* :ref:`genindex`
+* :ref:`modindex`

docs/index.rst

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/make.bat

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -eu
+
+sphinx-apidoc -f -o docs/_apidoc xarray_custom
+sphinx-build docs docs/_build