plotnine 0.15.0.dev3__tar.gz → 0.15.1__tar.gz

plotnine-0.15.1/.github/DISCUSSION_TEMPLATE/2025-plotnine-contest.yml

@@ -0,0 +1,103 @@
+labels: ["contest-2025"]
+body:
+  - type: markdown
+  
+    attributes:
+      value: >-
+        Thank you for submitting to the [2025 Plotnine Contest](https://github.com/has2k1/plotnine/discussions/972).
+        The submission deadline is Friday, October 3, 2025 ([Anywhere on Earth](https://time.is/Anywhere_on_Earth)).
+        
+        <details>
+        <summary><b>What should my submission include?</b></summary>
+        <br/>
+        To produce your final plot, every submission must include all the code, data, and processing steps, at least minimally documented.
+        <br/><br/>
+
+
+        #### 1. Code
+
+        <br>
+        A link to the repository or script that fully reproduces your submission. Please include any data used to produce the plot.
+        <br><br>
+
+        #### 2. Plot
+
+        <br>
+        Include your plot. If your submission includes many plots (e.g. it’s a multipart tutorial or article that includes many plots), please also link away to the full article. 
+        <br><br>
+
+        #### 3. Documentation
+
+        <br>
+        Whether as code comments or via prose in something like a Quarto doc or Jupyter notebook, be sure to include an explanation of what you are doing, and how your code works. Comments may be minimal, but they should help a novice to plotnine understand how your code produces your final plot.
+
+        <br/><br/>
+        </details>
+
+        
+        <details>
+        <summary><b>How will submissions be judged?</b></summary>
+        <br>
+
+
+        Broadly, entries will be judged based on utility and beauty. 
+        Is your plot easy to read and comprehend?
+        Is it a technically impressive, well-documented example?
+        Does it demonstrate novel, useful elements of plot design?
+        Is it aesthetically pleasing?
+        We recognize that some plots may excel in one of these categories, with some in another (and some in all).
+        We promise that the evaluation will keep this in mind.
+        <br><br>
+        We also realize our judging criteria are subjective.
+        Therefore, Hassan Kibirige, the creator of plotnine, along with a panel of visualization wizards will help review this year’s submissions. 
+
+        </details>
+
+        
+        <details>
+        <summary><b>What are the prizes?</b></summary>
+
+
+        #### 1. Fabulous Prizes
+        
+        We are still working out the fabulous prizes, but anticipate some beautiful combo of stickers, and sundry Posit swag.
+
+         
+        </details>
+
+  - type: textarea
+    id: output
+    attributes:
+      label: Plot
+      description: "This is your submission!"
+    validations:
+      required: true
+  - type: input
+    id: authors
+    attributes:
+      label: Authors
+      description: "List full names of all authors of the submission. If you include affiliation, please do so inside parentheses."
+    validations:
+      required: true
+  - type: input
+    id: links
+    attributes:
+      label: Links
+      description: "Any social or website links for authors. Use markdown for, e.g. `[twitter](https://twitter.com/HKibirige)`, `[github](https://github.com/has2k1)`"
+      placeholder: "e.g. [twitter](https://twitter.com/HKibirige), [github](https://github.com/has2k1)"
+    validations:
+      required: false
+  - type: textarea
+    id: description
+    attributes:
+      label: Full description
+      description: "Fully describe your submission. Feel free to link away to a Quarto Pub post, a README, personal blog, or similar. This can be edited after your submission."
+    validations:
+      required: true
+  - type: textarea
+    id: repo
+    attributes:
+      label: Code repository
+      description: "Link to a repo with data & code for reproducing your plotnine plot."
+    validations:
+      required: false

plotnine-0.15.1/.github/utils/_repo.py

@@ -0,0 +1,228 @@
+#!/usr/bin/env python
+from __future__ import annotations
+
+import os
+import re
+import shlex
+from subprocess import PIPE, Popen
+from typing import Literal, Sequence, TypeAlias
+
+ReleaseType: TypeAlias = Literal[
+    "alpha",
+    "beta",
+    "candidate",
+    "development",
+    "stable",
+]
+
+pre_release_lookup: dict[str, ReleaseType] = {
+    "a": "alpha",
+    "alpha": "alpha",
+    "b": "beta",
+    "beta": "beta",
+    "rc": "candidate",
+    "dev": "development",
+    ".dev": "development",
+}
+
+# https://docs.github.com/en/actions/learn-github-actions/variables
+# #default-environment-variables
+GITHUB_VARS = [
+    "GITHUB_REF_NAME",  # main, dev, v0.1.0, v0.1.3a1
+    "GITHUB_REF_TYPE",  # "branch" or "tag"
+    "GITHUB_REPOSITORY",  # has2k1/scikit-misc
+    "GITHUB_SERVER_URL",  # https://github.com
+    "GITHUB_SHA",  # commit shasum
+    "GITHUB_WORKSPACE",  # /home/runner/work/scikit-misc/scikit-misc
+    "GITHUB_EVENT_NAME",  # push, schedule, workflow_dispatch, ...
+]
+
+
+count = r"(?:[0-9]|[1-9][0-9]+)"
+DESCRIBE = re.compile(
+    r"^v"
+    rf"(?P<version>{count}\.{count}\.{count})"
+    rf"((?P<pre>a|b|rc|alpha|beta|\.dev){count})?"
+    r"(-(?P<commits>\d+)-g(?P<hash>[a-z0-9]+))?"
+    r"(?P<dirty>-dirty)?"
+    r"$"
+)
+
+# Define a stable release version to be valid according to PEP440
+# and is a semver
+STABLE_TAG = re.compile(r"^v" rf"{count}\.{count}\.{count}" r"$")
+
+# Prerelease version
+PRE_RELEASE_TAG = re.compile(
+    r"^v"
+    rf"{count}\.{count}\.{count}"
+    rf"((?P<pre>a|b|rc|alpha|beta|\.dev){count})?"
+    r"$"
+)
+
+REF_NAME = os.environ.get("GITHUB_REF_NAME", "")
+REF_TYPE = os.environ.get("GITHUB_REF_TYPE", "")
+
+
+def run(cmd: str | Sequence[str]) -> str:
+    if isinstance(cmd, str) and os.name == "posix":
+        cmd = shlex.split(cmd)
+    with Popen(
+        cmd, stdin=PIPE, stderr=PIPE, stdout=PIPE, text=True, encoding="utf-8"
+    ) as p:
+        stdout, _ = p.communicate()
+    return stdout.strip()
+
+
+class Git:
+    @staticmethod
+    def checkout(committish):
+        """
+        Return True if inside a git repo
+        """
+        res = run(f"git checkout {committish}")
+        return res
+
+    @staticmethod
+    def commit_titles(n=1) -> list[str]:
+        """
+        Return a list n of commit titles
+        """
+        output = run(
+            f"git log --oneline --no-merges --pretty='format:%s' -{n}"
+        )
+        return output.split("\n")[:n]
+
+    @staticmethod
+    def commit_messages(n=1) -> list[str]:
+        """
+        Return a list n of commit messages
+        """
+        sep = "______ MESSAGE _____"
+        output = run(
+            f"git log --no-merges --pretty='format:%B{sep}' -{n}"
+        ).strip()
+        if output.endswith(sep):
+            output = output[: -len(sep)]
+        return output.split(sep)[:n]
+
+    @staticmethod
+    def commit_title() -> str:
+        """
+        Commit subject
+        """
+        return Git.commit_titles(1)[0]
+
+    @staticmethod
+    def commit_message() -> str:
+        """
+        Commit title
+        """
+        return Git.commit_messages(1)[0]
+
+    @staticmethod
+    def is_repo():
+        """
+        Return True if inside a git repo
+        """
+        res = run("git rev-parse --is-inside-work-tree")
+        return res == "return"
+
+    @staticmethod
+    def fetch_tags() -> str:
+        """
+        Fetch all tags
+        """
+        return run("git fetch --tags --force")
+
+    @staticmethod
+    def is_shallow() -> bool:
+        """
+        Return True if current repo is shallow
+        """
+        res = run("git rev-parse --is-shallow-repository")
+        return res == "true"
+
+    @staticmethod
+    def deepen(n: int = 1) -> str:
+        """
+        Fetch n commits beyond the shallow limit
+        """
+        return run(f"git fetch --deepen={n}")
+
+    @staticmethod
+    def describe() -> str:
+        """
+        Git describe to determine version
+        """
+        return run("git describe --dirty --tags --long --match '*[0-9]*'")
+
+    @staticmethod
+    def can_describe() -> bool:
+        """
+        Return True if repo can be "described" from a semver tag
+        """
+        return bool(DESCRIBE.match(Git.describe()))
+
+    @staticmethod
+    def get_tag_at_commit(committish: str) -> str:
+        """
+        Get tag of a given commit
+        """
+        return run(f"git describe --exact-match {committish}")
+
+    @staticmethod
+    def tag_message(tag: str) -> str:
+        """
+        Get the message of a tag
+        """
+        return run(f"git tag -l --format='%(subject)' {tag}")
+
+    @staticmethod
+    def is_annotated(tag: str) -> bool:
+        """
+        Return true if tag is annotated tag
+        """
+        # LHS prints to stderr and returns nothing when
+        # tag is an empty string
+        return run(f"git cat-file -t {tag}") == "tag"
+
+    @staticmethod
+    def shallow_checkout(branch: str, url: str, depth: int = 1) -> str:
+        """
+        Shallow clone upto n commits
+        """
+        _branch = f"--branch={branch}"
+        _depth = f"--depth={depth}"
+        return run(f"git clone {_depth} {_branch} {url} .")
+
+    @staticmethod
+    def is_stable_release():
+        """
+        Return True if event is a stable release
+        """
+        return REF_TYPE == "tag" and bool(STABLE_TAG.match(REF_NAME))
+
+    @staticmethod
+    def is_pre_release():
+        """
+        Return True if event is any kind of pre-release
+        """
+        return REF_TYPE == "tag" and bool(PRE_RELEASE_TAG.match(REF_NAME))
+
+    @staticmethod
+    def release_type() -> ReleaseType | None:
+        if Git.is_stable_release():
+            return "stable"
+        elif Git.is_pre_release():
+            match = PRE_RELEASE_TAG.match(REF_NAME)
+            assert match is not None
+            pre = match.group("pre")
+            return pre_release_lookup[pre]
+
+    @staticmethod
+    def branch():
+        """
+        Return event branch
+        """
+        return REF_NAME if REF_TYPE == "branch" else ""

plotnine-0.15.1/.github/utils/please.py

@@ -0,0 +1,84 @@
+import os
+import sys
+from pathlib import Path
+from typing import Callable, TypeAlias
+
+from _repo import Git
+
+Ask: TypeAlias = Callable[[], bool | str]
+Do: TypeAlias = Callable[[], str]
+
+gh_output_file = os.environ.get("GITHUB_OUTPUT")
+
+
+def set_deploy_to():
+    """
+    Write where to deploy to deploy_on in the GITHUB_OUTPUT env
+    """
+    if not gh_output_file:
+        return
+
+    if Git.is_stable_release():
+        deploy_to = "website"
+    elif Git.is_pre_release():
+        deploy_to = "pre-website"
+    elif Git.branch() in {"main", "dev"}:
+        deploy_to = "gh-pages"
+    else:
+        deploy_to = ""
+
+    with Path(gh_output_file).open("a") as f:
+        print(f"deploy_to={deploy_to}", file=f)
+
+
+def set_publish_on():
+    """
+    Write index (pypi or testpypi) to publish_on in the GITHUB_OUTPUT env
+
+    i.e. Where to release
+    """
+    # Probably not on GHA
+    if not gh_output_file:
+        return
+
+    rtype = Git.release_type()
+
+    if rtype in {"stable", "alpha", "beta", "development"}:
+        publish_on = "pypi"
+    elif rtype == "candidate":
+        publish_on = "testpypi"
+    else:
+        publish_on = ""
+
+    with Path(gh_output_file).open("a") as f:
+        print(f"publish_on={publish_on}", file=f)
+
+
+def set_commit_title():
+    """
+    Write the commit title to commit_title in the GITHUB_OUTPUT env
+    """
+    if not gh_output_file:
+        return
+
+    with Path(gh_output_file).open("a") as f:
+        print(f"commit_title={Git.commit_title()}", file=f)
+
+
+def process_request(task_name: str) -> str | None:
+    if task_name in TASKS:
+        return TASKS[task_name]()
+
+
+TASKS: dict[str, Callable[[], str | None]] = {
+    "set_deploy_to": set_deploy_to,
+    "set_publish_on": set_publish_on,
+    "set_commit_title": set_commit_title,
+}
+
+if __name__ == "__main__":
+    if len(sys.argv) == 2:
+        arg = sys.argv[1]
+        output = process_request(arg)
+        if output:
+            print(output)

plotnine-0.15.1/.github/workflows/documentation.yml

@@ -0,0 +1,87 @@
+name: Documentation
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+env:
+  HEAD_COMMIT_MESSAGE: ${{ github.event.head_commit.message }}
+
+jobs:
+  parse_commit_info:
+    runs-on: ubuntu-latest
+    outputs:
+      deploy_to: ${{ steps.variables.outputs.deploy_to }}
+      commit_title: ${{ steps.variables.outputs.commit_title }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Copy build utils
+        run: cp -r .github/utils ../utils
+
+      - name: Decide where to deploy and create output variables
+        id: variables
+        run: |
+          python ../utils/please.py set_deploy_to
+          python ../utils/please.py set_commit_title
+
+          echo github.ref ${{ github.ref }}
+
+      - name: See outputs
+        run: |
+          echo 'deploy_to=${{ steps.variables.outputs.deploy_to }}'
+          echo 'commit_title=${{ steps.variables.outputs.commit_title }}'
+
+  build-documentation:
+    runs-on: ubuntu-latest
+    needs: parse_commit_info
+
+    strategy:
+      matrix:
+        python-version: [3.13]
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Install uv and set python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: pre-release
+
+      - name: Install Documentation Dependencies
+        run: |  
+          uv venv
+          make doc-dependencies
+
+      - name: Environment Information
+        run: |
+          ls -la
+          ls -la doc
+          uv pip list
+
+      - name: Build docs
+        run: make doc
+
+      - name: Environment Information
+        run: |
+          ls -la doc
+          ls -la doc/reference
+          cat doc/_variables.yml
+
+      - name: Deploy to Documentation to a Branch
+        uses: JamesIves/github-pages-deploy-action@v4
+        if:  ${{ needs.parse_commit_info.outputs.deploy_to != '' }}
+        with:
+          folder: doc/_site
+          branch: ${{ needs.parse_commit_info.outputs.deploy_to }}
+          commit-message: ${{ needs.parse_commit_info.outputs.commit_title }}

plotnine-0.15.1/.github/workflows/release.yml

@@ -0,0 +1,106 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]*'
+
+jobs:
+  run-tests:
+    name: Run all tests
+    uses: ./.github/workflows/testing.yml
+    with:
+      skip_codecov: true
+
+  check-semver-tag:
+    name: Check if the tag is in semantic version format
+    needs: [run-tests]
+    runs-on: ubuntu-latest
+    outputs:
+      publish_on: ${{ steps.variables.outputs.publish_on }}
+
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Copy build utils
+        run: cp -r .github/utils ../utils
+
+      - name: Decide where to publish and create output variables
+        id: variables
+        run: uv run python ../utils/please.py set_publish_on
+
+      - name: See outputs
+        run: echo "publish_on="${{ steps.variables.outputs.publish_on }}
+
+  # Ref: https://github.com/pypa/gh-action-pypi-publish
+  publish:
+    name: Build and publish Python 🐍 distributions 📦 to TestPyPI or PyPI
+    needs: [check-semver-tag]
+    runs-on: ubuntu-latest
+
+    if: ${{ needs.check-semver-tag.outputs.publish_on != '' }}
+
+    environment:
+      name: release
+      url: https://github.com/has2k1/plotnine
+
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Install a specific version of uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Packages
+        run: uv run uv pip install build
+
+      - name: Build a wheel and a source tarball
+        run: make dist
+
+      - name: Publish distribution 📦 to Test PyPI
+        if: ${{ needs.check-semver-tag.outputs.publish_on == 'testpypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+      - name: Publish distribution 📦 to PyPI
+        if: ${{ needs.check-semver-tag.outputs.publish_on == 'pypi' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+      - name: Build Website (Dev)
+        if: ${{ needs.check-semver-tag.outputs.publish_on == 'testpypi' }}
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.PLOTNINE_WEBSITE }}
+          repository: has2k1/plotnine.org
+          event-type: plotnine-pre-release
+
+      - name: Build Website
+        if: ${{ needs.check-semver-tag.outputs.publish_on == 'pypi' }}
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.PLOTNINE_WEBSITE }}
+          repository: has2k1/plotnine.org
+          event-type: plotnine-release