#39 Merge pull request from astropenguin/astropenguin/issue37

Update supported Python versions

.devcontainer/Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.10-slim
+
+ENV PATH=$PATH:/root/.local/bin
+ENV POETRY_VIRTUALENVS_CREATE=false
+ENV POETRY_VERSION=1.2.2
+
+RUN apt-get update \
+    && apt-get install -y curl git \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && curl -sSL https://install.python-poetry.org | python -

.devcontainer/devcontainer.json

@@ -0,0 +1,26 @@
+{
+    "name": "pandas-dataclasses",
+    "build": {
+        "context": "..",
+        "dockerfile": "Dockerfile"
+    },
+    "postCreateCommand": "poetry install",
+    "extensions": [
+        "github.vscode-pull-request-github",
+        "mhutchie.git-graph",
+        "ms-python.python",
+        "streetsidesoftware.code-spell-checker",
+        "tamasfe.even-better-toml"
+    ],
+    "settings": {
+        "files.insertFinalNewline": true,
+        "files.trimTrailingWhitespace": true,
+        "python.formatting.provider": "black",
+        "python.languageServer": "Pylance",
+        "[python]": {
+            "editor.formatOnSave": true,
+            "editor.insertSpaces": true,
+            "editor.tabSize": 4
+        }
+    }
+}

.github/workflows/gh-pages.yml

@@ -4,29 +4,25 @@ on:
   release:
     types:
       - created
-      - edited
 
 jobs:
   job:
     name: GitHub Pages
     runs-on: ubuntu-latest
+    env:
+      POETRY_VIRTUALENVS_CREATE: false
     steps:
       - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
+      - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
-      - name: Install dependencies
-        run: |
-          sudo apt install pandoc
-          pip install poetry
-          poetry install
+          python-version: "3.10"
+      - name: Install project dependencies
+        run: pip install poetry && poetry install
       - name: Build docs
-        run: poetry run scripts/docs
+        run: docs/build
       - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3
         with:
+          force_orphan: true
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./docs/_build
-          publish_branch: gh-pages
-          force_orphan: true

.github/workflows/pypi.yml

@@ -9,16 +9,12 @@ jobs:
   job:
     name: PyPI
     runs-on: ubuntu-latest
+    env:
+      POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - name: Setup Python
-        uses: actions/setup-python@v2
+      - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
-      - name: Install dependencies
-        run: |
-          pip install poetry
-      - name: Publish package
-        run: |
-          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
-          poetry publish --build
+          python-version: "3.10"
+      - name: Publish package to PyPI
+        run: pip install poetry && poetry publish --build

.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  job:
+    name: Test (Python ${{ matrix.python }})
+    runs-on: ubuntu-latest
+    env:
+      POETRY_VIRTUALENVS_CREATE: false
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.7", "3.8", "3.9", "3.10"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install project dependencies
+        run: pip install poetry && poetry install
+      - name: Test code's formatting (Black)
+        run: black --check azely docs tests
+      - name: Test code's execution (pytest)
+        run: pytest -v tests
+      - name: Test docs' building (Sphinx)
+        run: docs/build

docs/build

@@ -0,0 +1,4 @@
+#!/bin/bash -eu
+
+sphinx-apidoc -efT -o docs/_apidoc azely
+sphinx-build -a docs docs/_build

docs/conf.py

@@ -24,3 +24,39 @@
     "github_url": "https://github.com/astropenguin/azely/",
     "twitter_url": "https://twitter.com/astropengu_in/",
 }
+# project information
+author = "Akio Taniguchi"
+copyright = "2017-2022, Akio Taniguchi"
+
+
+# general configuration
+add_module_names = False
+autodoc_typehints = "both"
+autodoc_typehints_format = "short"
+exclude_patterns = [
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+]
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+myst_heading_anchors = 3
+templates_path = ["_templates"]
+
+
+# options for HTML output
+html_static_path = ["_static"]
+html_theme = "pydata_sphinx_theme"
+html_theme_options = {
+    "logo": {
+        "image_light": "logo-light.svg",
+        "image_dark": "logo-dark.svg",
+    },
+    "github_url": "https://github.com/astropenguin/pandas-dataclasses/",
+    "twitter_url": "https://twitter.com/astropengu_in/",
+}

docs/index.md

@@ -0,0 +1,11 @@
+```{include} ../README.md
+```
+
+```{toctree}
+---
+hidden:
+---
+
+Home <self>
+Package guide <_apidoc/azely>
+```