docstring-to-text 1.0.0__tar.gz → 1.0.1__tar.gz

{docstring_to_text-1.0.0 → docstring_to_text-1.0.1}/.github/workflows/publish-release-to-pypi.yml

@@ -33,22 +33,32 @@ on:
     paths:
       - "src/docstring_to_text/__package_meta.py"
 
+# ====== CONCURRENCY ======
+
+# Prevent multiple simultaneous builds for the same version:
+concurrency:
+  group: pypi-publish
+  # To group by version:
+  #group: pypi-publish-${{ github.ref }}-${{ hashFiles('src/docstring_to_text/__package_meta.py') }}
+  cancel-in-progress: false  # the second pending run is put into a queue, the third one is cancelled (GitHub limitation)
+
 # ======= ENV VARS =======
 
 env:
   # The name on PyPI:
   PACKAGE_NAME: 'docstring-to-text'
+  VERSION_FILE: 'src/docstring_to_text/__package_meta.py'
   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 🏷️
+    name: Parse version 🔢
+    # 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' }}
     runs-on: ubuntu-latest
     permissions:
@@ -64,15 +74,53 @@ jobs:
         with:
           fetch-depth: 0 # Fetch full history to avoid issues with tags and branches
 
-      - name: Extract version from package meta 📝
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - 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 }})")
+          # Try doing it with Python first:
+          VERSION=$(
+            python -c \
+            "from ${{ env.VERSION_MODULE }} import ${{ env.VERSION_VARIABLE }}; print(${{ env.VERSION_VARIABLE }})" \
+            2>/dev/null \
+            | head -1
+          )
+          if [ $? -ne 0 ] || [ -z "$VERSION" ]; then  # previous command had non-zero exit status or version is empty
+            echo "Failed to retrieve version with python. Attempting to parse it directly from file, with regexp..."
+            VERSION=$(
+              grep -oP "^\s*${{ env.VERSION_VARIABLE }}\s*=\s*['\"]\K[^'\"]+" "${{ env.VERSION_FILE }}" \
+              2>/dev/null \
+              | head -1
+            )
+          fi
+          if [ $? -ne 0 ] || [ -z "$VERSION" ]; then
+            echo "Error: Failed to retrieve version." >&2
+            exit 1
+          fi
           echo "Version string: $VERSION"
           echo "version=${VERSION}" >> $GITHUB_OUTPUT
 
-      - name: Parse Version 🧱
+      # TODO: get rid of the following bash insanity and just parse it with a special python script / shared module.
+      # Writing the output would use:
+      #   with open(os.environ['GITHUB_OUTPUT'], 'a') as fh:
+      #     print(f"{key}={value}", file=fh)
+#      - name: Parse Version with Python
+#        id: parse-with-python
+#        run: >-
+#          python parse_version.py
+#          "${{ steps.get_version_string.outputs.version }}"
+#        # Alternatively:
+#        #run: |
+#        #  python -c "
+#        #  # The entire python script inline
+#        #  version_str = '${{ steps.get_version_string.outputs.version }}'.lstrip('v')
+#        #  "
+
+      - name: Parse Version into parts 🧱
         id: parse
         # The main magic happens in regexps...
         # - `grep -qP`: verify that the tag matches the given pattern
@@ -121,29 +169,16 @@ jobs:
           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`
+    # It was in the template from official tutorial, but it got redundant with our deep version parsing and verification
+    # Kept here just as a condition example:
     #  && startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-latest
 
@@ -165,6 +200,8 @@ jobs:
         build
         --user
 
+    # TODO: run tests before the build
+
     - name: Build a binary wheel and a source tarball
       run: python3 -m build
 
@@ -233,30 +270,43 @@ jobs:
   # --------------------------------------------------------
 
   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
+    name: Create GitHub Tag 🏷️ and 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 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: ${{ needs.detect-version.outputs.tag_name }}
+
+      - 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-1.0.0 → docstring_to_text-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 1.0.0
+Version: 1.0.1
 Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
 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
@@ -34,12 +34,14 @@ class MyClass:
   to preserve paragraphs themselves.
   
   Also, when it comes to lists:
-  - You probably want to separate items
+    - You probably want to separate items
     with new lines.
-  - However, you don't want to preserve
+    - However, you don't want to preserve
     lines inside each item.
-  * And you might need various bullet
-    characters.
+  
+  And...
+  * ... you might need various bullet
+  characters.
   • Including unicode ones.
   
   And don't forget that the list still needs
@@ -65,7 +67,8 @@ You can't just remove all the new lines in the entire string, because you want t
 Also, when it comes to lists:
 - You probably want to separate items with new lines.
 - However, you don't want to preserve lines inside each item.
-* And you might need various bullet characters.
+And...
+* ... you might need various bullet characters.
 • Including unicode ones.
 And don't forget that the list still needs to be separated from the following text.
 ```

{docstring_to_text-1.0.0 → docstring_to_text-1.0.1}/README.md

@@ -19,12 +19,14 @@ class MyClass:
   to preserve paragraphs themselves.
   
   Also, when it comes to lists:
-  - You probably want to separate items
+    - You probably want to separate items
     with new lines.
-  - However, you don't want to preserve
+    - However, you don't want to preserve
     lines inside each item.
-  * And you might need various bullet
-    characters.
+  
+  And...
+  * ... you might need various bullet
+  characters.
   • Including unicode ones.
   
   And don't forget that the list still needs
@@ -50,7 +52,8 @@ You can't just remove all the new lines in the entire string, because you want t
 Also, when it comes to lists:
 - You probably want to separate items with new lines.
 - However, you don't want to preserve lines inside each item.
-* And you might need various bullet characters.
+And...
+* ... you might need various bullet characters.
 • Including unicode ones.
 And don't forget that the list still needs to be separated from the following text.
 ```

{docstring_to_text-1.0.0 → docstring_to_text-1.0.1}/src/docstring_to_text/__init__.py

@@ -11,6 +11,21 @@ import re as _re
 from .__package_meta import VERSION
 from .__package_meta import VERSION as __version__
 
+# TODO:
+# - lists
+#   formatted with indents
+#   in all lines except for the first one
+#
+# Also...
+#   - preserve indents
+#   - of the entire list
+#
+# And...
+#   - ensure
+#     that
+#     - it all works
+#       with nested lists
+
 
 _re_indent_match = _re.compile(r"(\t*)( +)(\t*)(.*?)$").match
 _re_tab_indent_match = _re.compile(r"(\t+)(.*?)$").match

{docstring_to_text-1.0.0 → docstring_to_text-1.0.1}/src/docstring_to_text/__package_meta.py

@@ -1,3 +1,3 @@
 # encoding: utf-8
 
-VERSION = "1.0.0"
+VERSION = "1.0.1"