Update auto docs to live in the auto dir

itamarst · Apr 27, 2024 · 5e0bb27 · 5e0bb27
1 parent afc4449
commit 5e0bb27
Show file tree

Hide file tree

Showing 23 changed files with 316 additions and 57 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -21,9 +21,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
+      uses: actions/checkout@v4.1.1
     - name: Set up Python 3.12 for linting
-      uses: actions/setup-python@v4.7.1
+      uses: actions/setup-python@v5.0.0
       with:
         python-version: '3.12'
     - name: Install dependencies
@@ -48,9 +48,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
+      uses: actions/checkout@v4.1.1
     - name: Set up Python 3.12
-      uses: actions/setup-python@v4.7.1
+      uses: actions/setup-python@v5.0.0
       with:
         python-version: '3.12'
     - name: Upgrade pip
@@ -66,7 +66,7 @@ jobs:
         python -m build --sdist --outdir wheelhouse
     - name: Install sdist
       run: |-
-        ls -al ./wheelhouse
+        ls -al wheelhouse
         pip install --prefer-binary wheelhouse/line_profiler*.tar.gz -v
     - name: Test minimal loose sdist
       run: |-
@@ -97,11 +97,11 @@ jobs:
         echo "MOD_DPATH = $MOD_DPATH"
         python -m pytest --verbose --cov={self.mod_name} $MOD_DPATH ../tests
         cd ..
-    - name: Upload sdist artifact
-      uses: actions/upload-artifact@v3
+    - uses: actions/upload-artifact@v4.3.1
+      name: Upload sdist artifact
       with:
-        name: wheels
-        path: ./wheelhouse/*.tar.gz
+        name: sdist_wheels
+        path: wheelhouse/*.tar.gz
   build_binpy_wheels:
     ##
     # Build the binary wheels. Note: even though cibuildwheel will test
@@ -111,6 +111,7 @@ jobs:
     name: ${{ matrix.os }}, arch=${{ matrix.arch }}
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         # Normally, xcookie generates explicit lists of platforms to build / test
         # on, but in this case cibuildwheel does that for us, so we need to just
@@ -127,7 +128,7 @@ jobs:
         - auto
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
+      uses: actions/checkout@v4.1.1
     - name: Enable MSVC 64bit
       uses: ilammy/msvc-dev-cmd@v1
       if: matrix.os == 'windows-latest' && ${{ contains(matrix.cibw_skip, '*-win32') }}
@@ -148,7 +149,7 @@ jobs:
       shell: bash
       run: ls -la wheelhouse
     - name: Set up Python 3.12 to combine coverage
-      uses: actions/setup-python@v4.7.1
+      uses: actions/setup-python@v5.0.0
       if: runner.os == 'Linux'
       with:
         python-version: '3.12'
@@ -167,11 +168,12 @@ jobs:
         echo '### The cwd should now have a coverage.xml'
         ls -altr
         pwd
-    - uses: codecov/codecov-action@v3
+    - uses: codecov/codecov-action@v4.0.1
       name: Codecov Upload
       with:
         file: ./coverage.xml
-    - uses: actions/upload-artifact@v3
+        token: ${{ secrets.CODECOV_TOKEN }}
+    - uses: actions/upload-artifact@v4.3.1
       name: Upload wheels artifact
       with:
         name: wheels
@@ -187,6 +189,7 @@ jobs:
     needs:
     - build_binpy_wheels
     strategy:
+      fail-fast: false
       matrix:
         # Xcookie generates an explicit list of environments that will be used
         # for testing instead of using the more concise matrix notation.
@@ -309,7 +312,7 @@ jobs:
           arch: auto
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
+      uses: actions/checkout@v4.1.1
     - name: Enable MSVC 64bit
       uses: ilammy/msvc-dev-cmd@v1
       if: matrix.os == 'windows-latest'
@@ -319,10 +322,10 @@ jobs:
       with:
         platforms: all
     - name: Setup Python
-      uses: actions/setup-python@v4.7.1
+      uses: actions/setup-python@v5.0.0
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4.1.2
       name: Download wheels
       with:
         name: wheels
@@ -386,10 +389,11 @@ jobs:
         echo '### The cwd should now have a coverage.xml'
         ls -altr
         pwd
-    - uses: codecov/codecov-action@v3
+    - uses: codecov/codecov-action@v4.0.1
       name: Codecov Upload
       with:
         file: ./coverage.xml
+        token: ${{ secrets.CODECOV_TOKEN }}
   test_deploy:
     name: Uploading Test to PyPi
     runs-on: ubuntu-latest
@@ -400,12 +404,17 @@ jobs:
     - test_binpy_wheels
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
-    - uses: actions/download-artifact@v3
-      name: Download wheels and sdist
+      uses: actions/checkout@v4.1.1
+    - uses: actions/download-artifact@v4.1.2
+      name: Download wheels
       with:
         name: wheels
         path: wheelhouse
+    - uses: actions/download-artifact@v4.1.2
+      name: Download sdist
+      with:
+        name: sdist_wheels
+        path: wheelhouse
     - name: Show files to upload
       shell: bash
       run: ls -la wheelhouse
@@ -433,7 +442,33 @@ jobs:
         pip install urllib3 requests[security] twine
         GPG_KEYID=$(cat dev/public_gpg_key)
         echo "GPG_KEYID = '$GPG_KEYID'"
-        DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh
+        GPG_SIGN_CMD="$GPG_EXECUTABLE --batch --yes --detach-sign --armor --local-user $GPG_KEYID"
+        WHEEL_PATHS=(wheelhouse/*.whl wheelhouse/*.tar.gz)
+        WHEEL_PATHS_STR=$(printf '"%s" ' "${WHEEL_PATHS[@]}")
+        echo "$WHEEL_PATHS_STR"
+        for WHEEL_PATH in "${WHEEL_PATHS[@]}"
+        do
+            echo "------"
+            echo "WHEEL_PATH = $WHEEL_PATH"
+            $GPG_SIGN_CMD --output $WHEEL_PATH.asc $WHEEL_PATH
+            $GPG_EXECUTABLE --verify $WHEEL_PATH.asc $WHEEL_PATH  || echo "hack, the first run of gpg very fails"
+            $GPG_EXECUTABLE --verify $WHEEL_PATH.asc $WHEEL_PATH
+        done
+        ls -la wheelhouse
+        pip install opentimestamps-client
+        ots stamp wheelhouse/*.whl wheelhouse/*.tar.gz wheelhouse/*.asc
+        ls -la wheelhouse
+        twine upload --username __token__ --password "$TWINE_PASSWORD" --repository-url "$TWINE_REPOSITORY_URL" wheelhouse/*.whl wheelhouse/*.tar.gz --skip-existing --verbose || { echo "failed to twine upload" ; exit 1; }
+    - uses: actions/upload-artifact@v4.3.1
+      name: Upload deploy artifacts
+      with:
+        name: deploy_artifacts
+        path: |-
+          wheelhouse/*.whl
+          wheelhouse/*.zip
+          wheelhouse/*.tar.gz
+          wheelhouse/*.asc
+          wheelhouse/*.ots
   live_deploy:
     name: Uploading Live to PyPi
     runs-on: ubuntu-latest
@@ -444,12 +479,17 @@ jobs:
     - test_binpy_wheels
     steps:
     - name: Checkout source
-      uses: actions/checkout@v4
-    - uses: actions/download-artifact@v3
-      name: Download wheels and sdist
+      uses: actions/checkout@v4.1.1
+    - uses: actions/download-artifact@v4.1.2
+      name: Download wheels
       with:
         name: wheels
         path: wheelhouse
+    - uses: actions/download-artifact@v4.1.2
+      name: Download sdist
+      with:
+        name: sdist_wheels
+        path: wheelhouse
     - name: Show files to upload
       shell: bash
       run: ls -la wheelhouse
@@ -477,6 +517,70 @@ jobs:
         pip install urllib3 requests[security] twine
         GPG_KEYID=$(cat dev/public_gpg_key)
         echo "GPG_KEYID = '$GPG_KEYID'"
-        DO_GPG=True GPG_KEYID=$GPG_KEYID TWINE_REPOSITORY_URL=${TWINE_REPOSITORY_URL} TWINE_PASSWORD=$TWINE_PASSWORD TWINE_USERNAME=$TWINE_USERNAME GPG_EXECUTABLE=$GPG_EXECUTABLE DO_UPLOAD=True DO_TAG=False ./publish.sh
+        GPG_SIGN_CMD="$GPG_EXECUTABLE --batch --yes --detach-sign --armor --local-user $GPG_KEYID"
+        WHEEL_PATHS=(wheelhouse/*.whl wheelhouse/*.tar.gz)
+        WHEEL_PATHS_STR=$(printf '"%s" ' "${WHEEL_PATHS[@]}")
+        echo "$WHEEL_PATHS_STR"
+        for WHEEL_PATH in "${WHEEL_PATHS[@]}"
+        do
+            echo "------"
+            echo "WHEEL_PATH = $WHEEL_PATH"
+            $GPG_SIGN_CMD --output $WHEEL_PATH.asc $WHEEL_PATH
+            $GPG_EXECUTABLE --verify $WHEEL_PATH.asc $WHEEL_PATH  || echo "hack, the first run of gpg very fails"
+            $GPG_EXECUTABLE --verify $WHEEL_PATH.asc $WHEEL_PATH
+        done
+        ls -la wheelhouse
+        pip install opentimestamps-client
+        ots stamp wheelhouse/*.whl wheelhouse/*.tar.gz wheelhouse/*.asc
+        ls -la wheelhouse
+        twine upload --username __token__ --password "$TWINE_PASSWORD" --repository-url "$TWINE_REPOSITORY_URL" wheelhouse/*.whl wheelhouse/*.tar.gz --skip-existing --verbose || { echo "failed to twine upload" ; exit 1; }
+    - uses: actions/upload-artifact@v4.3.1
+      name: Upload deploy artifacts
+      with:
+        name: deploy_artifacts
+        path: |-
+          wheelhouse/*.whl
+          wheelhouse/*.zip
+          wheelhouse/*.tar.gz
+          wheelhouse/*.asc
+          wheelhouse/*.ots
+  release:
+    name: Create Github Release
+    if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/tags') || startsWith(github.event.ref, 'refs/heads/release'))
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs:
+    - live_deploy
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4.1.1
+    - uses: actions/download-artifact@v4.1.2
+      name: Download artifacts
+      with:
+        name: deploy_artifacts
+        path: wheelhouse
+    - name: Show files to release
+      shell: bash
+      run: ls -la wheelhouse
+    - run: 'echo "Automatic Release Notes. TODO: improve" > ${{ github.workspace }}-CHANGELOG.txt'
+    - uses: softprops/action-gh-release@v1
+      name: Create Release
+      id: create_release
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        body_path: ${{ github.workspace }}-CHANGELOG.txt
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        body: Automatic Release
+        draft: true
+        prerelease: false
+        files: |-
+          wheelhouse/*.whl
+          wheelhouse/*.asc
+          wheelhouse/*.ots
+          wheelhouse/*.zip
+          wheelhouse/*.tar.gz
 
 
diff --git a/build_wheels.sh b/build_wheels.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 __doc__="
 Runs cibuildwheel to create linux binary wheels.
 

diff --git a/dev/setup_secrets.sh b/dev/setup_secrets.sh
@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 __doc__='
 ============================
 SETUP CI SECRET INSTRUCTIONS

diff --git a/docs/source/kernprof.rst → docs/source/auto/kernprof.rst b/docs/source/kernprof.rst → docs/source/auto/kernprof.rst
diff --git a/docs/source/line_profiler.__main__.rst → docs/source/auto/line_profiler.__main__.rst b/docs/source/line_profiler.__main__.rst → docs/source/auto/line_profiler.__main__.rst
diff --git a/docs/source/line_profiler._line_profiler.rst → ...rce/auto/line_profiler._line_profiler.rst b/docs/source/line_profiler._line_profiler.rst → ...rce/auto/line_profiler._line_profiler.rst
diff --git a/...er.autoprofile.ast_profle_transformer.rst → ...er.autoprofile.ast_profle_transformer.rst b/...er.autoprofile.ast_profle_transformer.rst → ...er.autoprofile.ast_profle_transformer.rst
diff --git a/...rofiler.autoprofile.ast_tree_profiler.rst → ...rofiler.autoprofile.ast_tree_profiler.rst b/...rofiler.autoprofile.ast_tree_profiler.rst → ...rofiler.autoprofile.ast_tree_profiler.rst
diff --git a/...line_profiler.autoprofile.autoprofile.rst → ...line_profiler.autoprofile.autoprofile.rst b/...line_profiler.autoprofile.autoprofile.rst → ...line_profiler.autoprofile.autoprofile.rst
diff --git a/...filer.autoprofile.line_profiler_utils.rst → ...filer.autoprofile.line_profiler_utils.rst b/...filer.autoprofile.line_profiler_utils.rst → ...filer.autoprofile.line_profiler_utils.rst
diff --git a/...rofiler.autoprofile.profmod_extractor.rst → ...rofiler.autoprofile.profmod_extractor.rst b/...rofiler.autoprofile.profmod_extractor.rst → ...rofiler.autoprofile.profmod_extractor.rst
diff --git a/docs/source/line_profiler.autoprofile.rst → ...source/auto/line_profiler.autoprofile.rst b/docs/source/line_profiler.autoprofile.rst → ...source/auto/line_profiler.autoprofile.rst
diff --git a/...line_profiler.autoprofile.util_static.rst → ...line_profiler.autoprofile.util_static.rst b/...line_profiler.autoprofile.util_static.rst → ...line_profiler.autoprofile.util_static.rst
diff --git a/...ource/line_profiler.explicit_profiler.rst → .../auto/line_profiler.explicit_profiler.rst b/...ource/line_profiler.explicit_profiler.rst → .../auto/line_profiler.explicit_profiler.rst
diff --git a/...ource/line_profiler.ipython_extension.rst → .../auto/line_profiler.ipython_extension.rst b/...ource/line_profiler.ipython_extension.rst → .../auto/line_profiler.ipython_extension.rst
diff --git a/docs/source/line_profiler.line_profiler.rst → ...urce/auto/line_profiler.line_profiler.rst b/docs/source/line_profiler.line_profiler.rst → ...urce/auto/line_profiler.line_profiler.rst
diff --git a/docs/source/line_profiler.rst → docs/source/auto/line_profiler.rst b/docs/source/line_profiler.rst → docs/source/auto/line_profiler.rst
diff --git a/docs/source/auto/line_profiler.timers.rst b/docs/source/auto/line_profiler.timers.rst
@@ -0,0 +1,8 @@
+line\_profiler.timers module
+============================
+
+.. automodule:: line_profiler.timers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/auto/line_profiler.unset_trace.rst b/docs/source/auto/line_profiler.unset_trace.rst
@@ -0,0 +1,8 @@
+line\_profiler.unset\_trace module
+==================================
+
+.. automodule:: line_profiler.unset_trace
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
diff --git a/docs/source/auto/modules.rst b/docs/source/auto/modules.rst
@@ -0,0 +1,7 @@
+line_profiler
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   line_profiler