ci: setup release pipeline

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  workflow_dispatch:
+
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
+
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
+
+jobs:
+  test:
+    # We want to run on external PRs, but not on our own internal PRs as they'll be run
+    # by the push to the branch. Without this if check, checks are duplicated since
+    # internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
+      github.repository
+
+    name: Python ${{ matrix.python-version }} tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Load cached venv
+        uses: actions/cache@v2
+        id: cached-poetry-dependencies
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: |
+          poetry lock --no-update
+          poetry install
+          python -m pip install pytest-github-actions-annotate-failures
+
+      - name: Run tests
+        id: tests
+        run: |
+          poetry run pytest -vvv
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check format with black
+        uses: psf/black@stable
+        with:
+          options: "--diff --check --color --verbose"
+
+  commit-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Lint commit messages
+        uses: wagoid/commitlint-github-action@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          failOnWarnings: 'false'
+          commitDepth: 1

.github/workflows/release.yml

@@ -0,0 +1,129 @@
+name: Test & Release
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }} tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        id: setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+
+      - name: Load cached venv
+        uses: actions/cache@v2
+        id: cached-poetry-dependencies
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: |
+          poetry lock --no-update
+          poetry install
+          python -m pip install pytest-github-actions-annotate-failures
+
+      - name: Run tests
+        id: tests
+        run: |
+          poetry run pytest -vvv
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check format with black
+        uses: psf/black@stable
+        with:
+          options: "--diff --check --color --verbose"
+
+  commit-lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Lint commit messages
+        uses: wagoid/commitlint-github-action@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          failOnWarnings: 'false'
+          commitDepth: 1
+
+  release:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    concurrency: push
+    needs: [test, lint, commit-lint]
+    if: github.repository == 'xability/py_maidr'
+    environment:
+      name: pypi
+      url: https://pypi.org/project/maidr/
+    permissions:
+      # https://docs.github.com/en/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#metadata
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref_name }}
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          root_options: "-vv"
+
+      # see https://docs.pypi.org/trusted-publishers/
+      - name: Publish package distributions to PyPI
+        id: pypi-publish
+        # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
+        # See https://github.com/actions/runner/issues/1173
+        if: steps.release.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+      - name: Publish package distributions to GitHub Releases
+        id: github-release
+        # NOTE: DO NOT wrap the conditional in ${{ }} as it will always evaluate to true.
+        # See https://github.com/actions/runner/issues/1173
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/upload-to-gh-release@main
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}
+          root_options: "-vv"

docs/_quarto.yml

@@ -0,0 +1,70 @@
+project:
+  type: website
+  output-dir: _site
+
+website:
+  title: "PyMAIDR"
+
+  site-url: https://xability.github.io/py_maidr/
+  repo-url: https://github.com/xability/py_maidr
+  issue-url: https://github.com/xability/py_maidr/issues/new/choose
+  repo-actions: [issue]
+
+  page-navigation: true
+  bread-crumbs: true
+
+  navbar:
+    background: light
+    # logo: quarto.png
+    logo-alt: "Maidr logo."
+    logo-href: https://xability.github.io/py_maidr/
+    title: PyMAIDR
+    collapse-below: lg
+    left:
+      - text: "Overview"
+        href: _index.qmd
+      - text: "Get Started"
+        href: _get_started.qmd
+      - text: "API Reference"
+        href: api/core/index.qmd
+    right:
+      - icon: github
+        href: https://github.com/xability/maidr
+        aria-label: GitHub
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+
+quartodoc:
+  package: maidr
+  dir: api/core
+  sidebar: _sidebar.yml
+  style: pkgdown
+  title: "PyMAIDR"
+  renderer:
+    style: markdown
+  sections:
+    - title: Plot API
+      desc: ""
+      contents:
+        - bar
+        - box
+        - count
+        - heat
+        - hist
+        - line
+        - scatter
+
+    - title: Maidr API
+      desc: ""
+      package: maidr.core
+      contents:
+        - Maidr.render
+        - Maidr.show
+        - Maidr.save_html
+
+
+

docs/styles.css

@@ -0,0 +1 @@
+/* css styles */

maidr/__init__.py

@@ -1,5 +1,4 @@
-# __version__ will be automatically updated by python-semantic-release
-__version__ = "0.0.1"
+__version__ = "0.1.2"
 
 from .core import Maidr
 from .core.enum import PlotType

maidr/core/figure_manager.py

@@ -63,7 +63,7 @@ def _get_maidr(cls, fig: Figure) -> Maidr:
     def get_axes(
         artist: Artist | Axes | BarContainer | dict | list | None,
     ) -> Any:
-        """Recursively extracts Axes objects from the input artist or container."""
+        """Recursively extract Axes objects from the input artist or container."""
         if artist is None:
             return None
         elif isinstance(artist, Axes):

maidr/core/maidr.py

@@ -108,7 +108,7 @@ def _create_html_doc(self) -> HTMLDocument:
         return HTMLDocument(self._create_html_tag(), lang="en")
 
     def _flatten_maidr(self) -> dict | list[dict]:
-        """Returns a single plot schema or a list of schemas from the Maidr instance."""
+        """Return a single plot schema or a list of schemas from the Maidr instance."""
         maidr = [plot.schema for plot in self._plots]
         return maidr if len(maidr) != 1 else maidr[0]