docstring-to-text 0.0.1__tar.gz → 0.0.2__tar.gz

docstring_to_text-0.0.2/.github/workflows/publish-release-to-pypi.yml

@@ -0,0 +1,262 @@
+# Prerequisites:
+#
+# - In GitHub repo - create the publishing environment (here, `pypi` / `testpypi`)
+#   https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments
+#
+# - Create a "Trusted Publisher" in the project settings on (test)PyPI
+#   https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+#   https://pypi.org/manage/project/docstring-to-text/settings/publishing/
+
+# Tutorials:
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+# https://www.youtube.com/watch?v=NMQwzI9hprg
+# https://github.com/ArjanCodes/moneysnake/blob/main/.github/workflows/release.yaml
+
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+# ======= TRIGGERS =======
+
+#on:
+#  push:
+#    tags:
+#      # Trigger on tags with '[v]<int>.<int>whatever' pattern: 'v1.0.0', 'v2.1.4', etc
+#      # https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#filter-pattern-cheat-sheet
+#      # https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onpushbranchestagsbranches-ignoretags-ignore
+#      - 'v[0-9]+.[0-9]**'
+#      - '[0-9]+.[0-9]**'
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "src/docstring_to_text/__package_meta.py"
+
+# ======= ENV VARS =======
+
+env:
+  # The name on PyPI:
+  PACKAGE_NAME: 'docstring-to-text'
+  VERSION_MODULE: 'src.docstring_to_text.__package_meta'
+  VERSION_VARIABLE: 'VERSION'
+
+
+# ========= JOBS =========
+
+jobs:
+
+  detect-version:
+    # https://emojidb.org/query-emojis
+    name: Parse version 🔢 + add Tag 🏷️
+    if: ${{ github.repository_owner == 'Lex-DRL' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Needed for tag creation
+    outputs:
+      tag_name: ${{ steps.parse.outputs.tag_name }}
+      version_full: ${{ steps.parse.outputs.version_full }}
+      version_num: ${{ steps.parse.outputs.version_num }}
+      suffix: ${{ steps.parse.outputs.suffix }}
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch full history to avoid issues with tags and branches
+
+      - name: Extract version from package meta 📝
+        id: get_version_string
+        run: |
+          # VERSION=$(grep -oP 'VERSION\s*=\s*["'\'']\K[^"'\'']+' src/docstring_to_text/__package_meta.py)
+          VERSION=$(python -c "from ${{ env.VERSION_MODULE }} import ${{ env.VERSION_VARIABLE }}; print(${{ env.VERSION_VARIABLE }})")
+          echo "Version string: $VERSION"
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+
+      - name: Parse Version 🧱
+        id: parse
+        # The main magic happens in regexps...
+        # - `grep -qP`: verify that the tag matches the given pattern
+        # - `sed -E 's/regex_pattern/replacement/optional_flags'`, with '\1' in replacement meaning first group
+        # The regexp itself:
+        # - '^v?([0-9]+\.[0-9]+\.[0-9]+)' - matches 'v1.2.3' / '1.2.3' from start of the string, 'v' stripped
+        #   - '^' - start of the input string.
+        #   - 'v?(...)' - optional 'v' prefix (might be missing), and what follows is captured as a group.
+        #   - '[0-9]+' - a sequence of 1 or more digits.
+        #   - '\.' - literal dot (just '.' matches any character).
+        # - '(-.+)?$' - suffix captured as a group:
+        #   - '-' - just a hyphen.
+        #   - '.+' - any non-empty string (at least one any character - including another hyphen, dot or digit).
+        #   - '(...)?$' - a group that might be present or not.
+        #   - '$' - the end of the input string.
+        run: |
+          VERSION_STR="${{ steps.get_version_string.outputs.version }}"
+          echo "Version string: $VERSION_STR"
+          if echo "$VERSION_STR" | grep -qP '^v?[0-9]+\.[0-9]+\.[0-9]+(-.+)?$'; then
+            VERSION_NUMBER=$(echo "$VERSION_STR" | sed -E 's/^v?([0-9]+\.[0-9]+\.[0-9]+)(-.+)?$/\1/')
+            echo "Version number: $VERSION_NUMBER"
+            if echo "$VERSION_STR" | grep -q '-'; then
+              # We can only get into this branch if the initial grep regex worked AND '-' is there
+              # So it's '[v]1.2.3-something'
+              SUFFIX=$(echo "$VERSION_STR" | sed -E 's/^v?([0-9]+\.[0-9]+\.[0-9]+)-(.+)$/\2/')
+              if echo "$SUFFIX" | grep -q '-'; then
+                echo "Invalid suffix (it contains hyphen): $SUFFIX" >&2
+                exit 1
+              fi
+              SUFFIX_WITH_SEP=$(echo "-$SUFFIX")
+            else
+              SUFFIX=""
+              SUFFIX_WITH_SEP=""
+            fi
+            echo "Suffix: $SUFFIX"
+          else
+            echo "Version string doesn't match the '[v]1.2.3[-suffix]' pattern: $VERSION_STR" >&2
+            exit 1
+          fi
+          VERSION_FULL=$(echo "${VERSION_NUMBER}${SUFFIX_WITH_SEP}")
+          echo "Full parsed Version: $VERSION_FULL"
+          TAG_NAME=$(echo "v${VERSION_FULL}")
+          echo "Tag name: $TAG_NAME"
+          echo "tag_name=$TAG_NAME" >> "$GITHUB_OUTPUT"
+          echo "version_full=$VERSION_FULL" >> "$GITHUB_OUTPUT"
+          echo "version_num=$VERSION_NUMBER" >> "$GITHUB_OUTPUT"
+          echo "suffix=$SUFFIX" >> "$GITHUB_OUTPUT"
+
+      - name: Create tag 🏷️ from version
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.git.createRef({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              ref: `refs/tags/${process.env.TAG}`,
+              sha: context.sha
+            })
+        env:
+          TAG: ${{ steps.parse.outputs.tag_name }}
+
+  # --------------------------------------------------------
+
+  build:
+    name: Build distribution 📦
+    needs: [detect-version]  # No need to even try, if we failed tag parsing
+    # Just to be nice - let's check the GitHub user and prevent unwanted auto-runs on forks made solely for a PR.
+    if: >-
+      github.repository_owner == 'Lex-DRL'
+    # Second condition: only run on tag pushes...
+    # It was in the template from official tutorial, but it got redundant, since the only trigger is `on.push.tags`
+    #  && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  # --------------------------------------------------------
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI ⬆️
+    if: ${{ github.repository_owner == 'Lex-DRL' }}
+    needs:
+    - build  # Requires the previous 'build' job to succeed
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ env.PACKAGE_NAME }}
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  # --------------------------------------------------------
+
+#  publish-to-testpypi:
+#    name: Publish Python 🐍 distribution 📦 to TestPyPI ❗
+#    if: ${{ github.repository_owner == 'Lex-DRL' }}
+#    needs:
+#    - build  # Requires the previous 'build' job to succeed
+#    runs-on: ubuntu-latest
+#
+#    environment:
+#      #name: testpypi
+#      # Yes, it's "not cool" to use the same environment for testing and publishing,
+#      # but in this particular repo I only use the TestPyPI for initial debugging of the workflow
+#      name: pypi
+#      url: https://test.pypi.org/p/${{ env.PACKAGE_NAME }}
+#    permissions:
+#      id-token: write  # IMPORTANT: mandatory for trusted publishing
+#
+#    steps:
+#    - name: Download all the dists
+#      uses: actions/download-artifact@v4
+#      with:
+#        name: python-package-distributions
+#        path: dist/
+#
+#    - name: Publish distribution 📦 to TestPyPI
+#      uses: pypa/gh-action-pypi-publish@release/v1
+#      with:
+#        repository-url: https://test.pypi.org/legacy/
+
+  # --------------------------------------------------------
+
+  github_release:
+      name: Create GitHub Release 🔄
+      needs: [build, detect-version]
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write
+      steps:
+        - name: Checkout Code
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0 # Fetch full history to avoid issues with tags and branches
+
+        - name: Download artifacts
+          uses: actions/download-artifact@v4
+          with:
+            name: python-package-distributions
+            path: dist/
+
+        - name: Create GitHub Release
+          id: create_release
+          env:
+            GH_TOKEN: ${{ github.token }}
+          run: >-
+            gh release create
+            ${{ needs.detect-version.outputs.tag_name }}
+            dist/*
+            --title ${{ needs.detect-version.outputs.tag_name }}
+            --generate-notes

{docstring_to_text-0.0.1 → docstring_to_text-0.0.2}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 0.0.1
+Version: 0.0.2
 Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
-Project-URL: Homepage, https://github.com/Lex-DRL/Py-docstring-to-text
+Project-URL: Source Code, https://github.com/Lex-DRL/Py-docstring-to-text
 Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
 Author: Lex Darlog (Lex-DRL)
 License-Expression: MPL-2.0

{docstring_to_text-0.0.1 → docstring_to_text-0.0.2}/_build.bat

@@ -1,23 +1,24 @@
-@echo off
-
-call .\venv\Scripts\activate.bat
-
-echo Where python:
-echo.
-where python
-echo.
-echo Continue?
-
-pause
-
-.\venv\Scripts\python.exe -m pip install -U pip
-.\venv\Scripts\python.exe -m pip install -U build
-
-echo.
-echo.
-echo ============================================================
-echo.
-echo.
-
-.\venv\Scripts\python.exe -m build
-pause
+@echo off
+
+call .\venv\Scripts\activate.bat
+
+echo Where python:
+echo.
+where python
+echo.
+echo                     BUILD?
+echo.
+
+pause
+
+.\venv\Scripts\python.exe -m pip install -U pip
+.\venv\Scripts\python.exe -m pip install -U build
+
+echo.
+echo.
+echo ============================================================
+echo.
+echo.
+
+.\venv\Scripts\python.exe -m build
+pause

docstring_to_text-0.0.2/_upload-release.bat

@@ -0,0 +1,24 @@
+@echo off
+
+call .\venv\Scripts\activate.bat
+
+echo Where python:
+echo.
+where python
+echo.
+echo                     RELEASE?
+echo.
+
+pause
+
+.\venv\Scripts\python.exe -m pip install -U pip
+.\venv\Scripts\python.exe -m pip install -U twine
+
+echo.
+echo.
+echo ============================================================
+echo.
+echo.
+
+.\venv\Scripts\python.exe -m twine upload dist/*
+pause

docstring_to_text-0.0.2/_upload-test.bat

@@ -0,0 +1,24 @@
+@echo off
+
+call .\venv\Scripts\activate.bat
+
+echo Where python:
+echo.
+where python
+echo.
+echo                     Upload to TEST PyPI?
+echo.
+
+pause
+
+.\venv\Scripts\python.exe -m pip install -U pip
+.\venv\Scripts\python.exe -m pip install -U twine
+
+echo.
+echo.
+echo ============================================================
+echo.
+echo.
+
+.\venv\Scripts\python.exe -m twine upload --repository testpypi dist/*
+pause

{docstring_to_text-0.0.1 → docstring_to_text-0.0.2}/pyproject.toml

@@ -1,3 +1,5 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+
 [build-system]
 requires = ["hatchling >= 1.26"]
 build-backend = "hatchling.build"
@@ -23,7 +25,7 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/Lex-DRL/Py-docstring-to-text"
+"Source Code" = "https://github.com/Lex-DRL/Py-docstring-to-text"
 Issues = "https://github.com/Lex-DRL/Py-docstring-to-text/issues"
 
 [tool.hatch.version]

{docstring_to_text-0.0.1 → docstring_to_text-0.0.2}/src/docstring_to_text/__package_meta.py

@@ -1,3 +1,3 @@
 # encoding: utf-8
 
-VERSION = "0.0.1"
+VERSION = "0.0.2"