Merge pull request #4 from astropenguin/#3-dev-environment

Update dev environment

.github/workflows/gh-pages.yml

@@ -15,14 +15,14 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install dependencies
         run: |
           sudo apt install pandoc
           pip install poetry
           poetry install
       - name: Build docs
-        run: poetry run scripts/docs
+        run: poetry run docs/build
       - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3
         with:

.github/workflows/pypi.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
       - name: Install dependencies
         run: |
           pip install poetry

.github/workflows/test.yml → .github/workflows/tests.yml

@@ -1,20 +1,22 @@
-name: Test
+name: Tests
 
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   job:
-    name: Test
+    name: Test (Python ${{ matrix.python-version }})
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.7, 3.8, 3.9]
+    env:
+      TESTED_DIRS: docs tests xarray_accessors
     steps:
       - uses: actions/checkout@v2
       - name: Setup Python ${{ matrix.python-version }}
@@ -26,11 +28,11 @@ jobs:
           sudo apt install pandoc
           pip install poetry
           poetry install
-      - name: Lint by Flake8
-        run: poetry run flake8 docs tests xarray_accessors
-      - name: Format by Black
-        run: poetry run black --check docs tests xarray_accessors
-      - name: Test by pytest
+      - name: Test code format (Black)
+        run: poetry run black --check ${TESTED_DIRS}
+      - name: Test code style (Flake8)
+        run: poetry run flake8 ${TESTED_DIRS}
+      - name: Test package (pytest)
         run : poetry run pytest -v tests
-      - name: Build docs
-        run: poetry run scripts/docs
+      - name: Test docs building (Sphinx)
+        run: poetry run docs/build

.gitignore

@@ -1,6 +1,7 @@
-# Editor settings
-.vscode
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
 
+### Python ###
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -23,7 +24,6 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
 share/python-wheels/
 *.egg-info/
 .installed.cfg
@@ -53,6 +53,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -72,11 +73,12 @@ instance/
 .scrapy
 
 # Sphinx documentation
+docs/readme.rst
 docs/_apidoc/
 docs/_build/
-docs/readme.rst
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -87,7 +89,9 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
 
 # pipenv
 #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
@@ -132,3 +136,11 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://www.toptal.com/developers/gitignore/api/python

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "editor.formatOnSave": true,
+    "python.analysis.typeCheckingMode": "strict",
+    "python.formatting.provider": "black",
+    "python.languageServer": "Pylance",
+    "python.linting.enabled": true,
+    "python.linting.lintOnSave": true,
+    "python.linting.flake8Enabled": true,
+}

.zenodo.json

@@ -0,0 +1,9 @@
+{
+    "creators": [
+        {
+            "name": "Akio Taniguchi",
+            "affiliation": "Nagoya University",
+            "orcid": "0000-0002-9695-6183"
+        }
+    ]
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Akio Taniguchi
+Copyright (c) 2020-2021 Akio Taniguchi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,4 +5,4 @@
 [![Test](https://img.shields.io/github/workflow/status/astropenguin/xarray-accessors/Test?logo=github&label=Test&style=flat-square)](https://github.com/astropenguin/xarray-accessors/actions)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?label=License&style=flat-square)](LICENSE)
 
-xarray extension for dataarray accessors
+xarray extension for easy accessor creation

scripts/docs → docs/build

@@ -4,10 +4,8 @@
 # convert README.md to readme.rst
 pandoc --column 500 -f markdown -t rst -o docs/readme.rst README.md
 
-
 # auto-generate package guide
 sphinx-apidoc -efT -o docs/_apidoc xarray_accessors
 
-
 # build website
 sphinx-build -a docs docs/_build

docs/conf.py

@@ -1,6 +1,6 @@
 # Project information
 author = "Akio Taniguchi"
-copyright = "2020, Akio Taniguchi"
+copyright = "2020-2021, Akio Taniguchi"
 
 
 # General configuration