nextpipe 0.3.0__tar.gz → 0.3.2.dev0__tar.gz

nextpipe-0.3.2.dev0/.github/workflows/release.yml

@@ -0,0 +1,190 @@
+name: release
+run-name: Release ${{ inputs.VERSION }} by @${{ github.actor }} from ${{ github.ref_name }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: "The version to release"
+        required: true
+  push:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      VERSION: ${{ inputs.VERSION }}
+      GH_TOKEN: ${{ github.token }}
+      SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+      IS_AUTOMATED: true
+      RELEASE_NEEDED: true
+      IS_PRE_RELEASE: true
+    permissions:
+      contents: write # Required for creating releases and tags
+      id-token: write # This is required for trusted publishing to PyPI
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nextpipe
+    steps:
+      - name: set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install build hatch
+
+      - name: configure git with the bot credentials
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan github.com >> ~/.ssh/known_hosts
+          ssh-agent -a $SSH_AUTH_SOCK > /dev/null
+          ssh-add - <<< "${{ secrets.NEXTMVBOT_SSH_KEY }}"
+
+          echo "${{ secrets.NEXTMVBOT_SIGNING_KEY }}" > ~/.ssh/signing.key
+          chmod 600 ~/.ssh/signing.key
+
+          git config --global user.name "nextmv-bot"
+          git config --global user.email "tech+gh-nextmv-bot@nextmv.io"
+          git config --global gpg.format ssh
+          git config --global user.signingkey ~/.ssh/signing.key
+
+          git clone git@github.com:nextmv-io/nextpipe.git
+          cd nextpipe
+          git switch ${{ github.ref_name }}
+
+      - name: check that a manual release cannot be done on develop
+        if: ${{ env.IS_AUTOMATED == 'false' && github.ref_name == 'develop' }}
+        run: |
+          echo "Manual release cannot be done on develop"
+          exit 1
+
+      - name: set the automated flag based on workflow trigger
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            echo "IS_AUTOMATED=false" >> $GITHUB_ENV
+            exit 0
+          fi
+
+          echo "IS_AUTOMATED=true" >> $GITHUB_ENV
+
+      - name: set filters file for changed paths - automated mode
+        if: ${{ env.IS_AUTOMATED == 'true' }}
+        run: |
+          FILTERS_FILE="./.github/filters.yml"
+          touch $FILTERS_FILE
+          echo "nextpipe:" >> $FILTERS_FILE
+          echo "  - 'nextpipe/__about__.py'" >> $FILTERS_FILE
+
+          echo "Successfully created filters and wrote them to ${FILTERS_FILE}"
+          cat $FILTERS_FILE
+        working-directory: ./nextpipe
+
+      - name: filter changed directories - automated mode
+        if: ${{ env.IS_AUTOMATED == 'true' }}
+        id: filter
+        uses: dorny/paths-filter@v3
+        with:
+          filters: .github/filters.yml
+          working-directory: ./nextpipe
+
+      - name: determine if release is needed
+        run: |
+          echo "Checking if release is needed"
+          echo "IS_AUTOMATED: ${{ env.IS_AUTOMATED }}"
+          if [ "${{ env.IS_AUTOMATED }}" = "false" ]; then
+            echo "RELEASE_NEEDED=true" >> $GITHUB_ENV
+            echo "Manual mode - Release is needed"
+            exit 0
+          fi
+
+          CHANGES=${{ steps.filter.outputs.changes }}
+          echo "CHANGES: $CHANGES"
+          CHANGES_ARE_ZERO=$(echo $CHANGES | jq '. | length == 0')
+          if [ "$CHANGES_ARE_ZERO" = "true" ]; then
+            echo "Automated mode - No changes detected"
+            echo "RELEASE_NEEDED=false" >> $GITHUB_ENV
+            echo "Automated mode - Release is not needed"
+            exit 0
+          fi
+
+          echo "RELEASE_NEEDED=true" >> $GITHUB_ENV
+          echo "Automated mode - Release is needed"
+
+      - name: upgrade version with hatch - manual mode
+        if: ${{ env.IS_AUTOMATED == 'false' && env.RELEASE_NEEDED == 'true' }}
+        run: hatch version ${{ inputs.VERSION }}
+        working-directory: ./nextpipe
+
+      - name: set the package version
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        run: |
+          export VERSION="v$(hatch version)"
+          echo "This is the version"
+          echo $VERSION
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+          # Check if version is a pre-release
+          if [[ "$VERSION" =~ (alpha|beta|rc|dev|pre|a|b) ]]; then
+            echo "IS_PRE_RELEASE=true" >> $GITHUB_ENV
+            echo "Detected pre-release version: $VERSION"
+            exit 0
+          fi
+
+          echo "IS_PRE_RELEASE=false" >> $GITHUB_ENV
+          echo "Detected stable release version: $VERSION"
+        working-directory: ./nextpipe
+
+      - name: bump version in requirements.txt
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        run: |
+          bash .nextmv/bump_requirements.sh ${{ env.VERSION }}
+        working-directory: ./nextpipe
+
+      - name: commit new version - manual mode
+        if: ${{ env.IS_AUTOMATED == 'false' && env.RELEASE_NEEDED == 'true' }}
+        run: |
+          git add nextpipe/__about__.py
+          git commit -S -m "Bump nextpipe version to ${{ env.VERSION }}"
+          git push
+        working-directory: ./nextpipe
+
+      - name: tag new version
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        run: |
+          git tag ${{ env.VERSION }}
+          git push origin ${{ env.VERSION }}
+        working-directory: ./nextpipe
+
+      - name: create release
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        run: |
+          PRERELEASE_FLAG=""
+          if [ ${{ env.IS_PRE_RELEASE }} = true ]; then
+            PRERELEASE_FLAG="--prerelease"
+          fi
+
+          gh release create $VERSION \
+          --verify-tag \
+          --generate-notes \
+          --title $VERSION $PRERELEASE_FLAG
+        working-directory: ./nextpipe
+
+      - name: build binary wheel and source tarball
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        run: python -m build
+        working-directory: ./nextpipe
+
+      - name: publish package distributions to PyPI
+        if: ${{ env.RELEASE_NEEDED == 'true' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: ./nextpipe/dist
+
+      - name: notify slack
+        if: ${{ env.RELEASE_NEEDED == 'true' && env.IS_PRE_RELEASE == 'false' }}
+        run: |
+          export DATA="{\"text\":\"Release notification - nextpipe ${{ inputs.VERSION }} (see <https://github.com/nextmv-io/nextpipe/releases/${{ inputs.VERSION }}|release notes> / <https://pypi.org/project/nextpipe|PyPI>)\"}"
+          curl -X POST -H 'Content-type: application/json' --data "$DATA" ${{ secrets.SLACK_URL_MISSION_CONTROL }}

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: nextpipe
-Version: 0.3.0
+Version: 0.3.2.dev0
 Summary: Framework for Decision Pipeline modeling and execution
 Project-URL: Homepage, https://www.nextmv.io
-Project-URL: Documentation, https://www.nextmv.io/docs
+Project-URL: Documentation, https://nextpipe.docs.nextmv.io/en/latest/
 Project-URL: Repository, https://github.com/nextmv-io/nextpipe
 Author-email: Nextmv <tech@nextmv.io>
 Maintainer-email: Nextmv <tech@nextmv.io>

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/docs/examples/complex-workflow-csv.md

@@ -85,7 +85,7 @@ class Workflow(FlowSpec):
     @app(
         app_id="routing-nextroute",
         instance_id="latest",
-        parameters={"solve.duration": "30s"},
+        options={"solve.duration": "30s"},
         full_result=True,
     )
     @repeat(repetitions=3)

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/docs/examples/ensemble-workflow.md

@@ -15,7 +15,7 @@ workflow that runs multiple solver instances in parallel and then picks the
 best result.
 
 This is useful when you want to run multiple solver instances with different
-parameters or configurations, and then select the best result from the
+options or configurations, and then select the best result from the
 ensemble.
 
 ```python

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/docs/examples/fanout-workflow.md

@@ -7,11 +7,11 @@
 
 This is a more advanced example demonstrating dynamic fanout and joining of
 results. This example shows how to create multiple copies of the input data,
-configure them with different parameters, and then run the model in parallel.
+configure them with different options, and then run the model in parallel.
 Finally, it collects the results and merges them into a single output.
 
 This is useful when you need to parallelize the execution of a model with
-different configurations or parameters.
+different configurations or options.
 
 ```python
 import copy
@@ -28,7 +28,7 @@ class Workflow(FlowSpec):
     @step
     def fanout(data: dict[str, Any]) -> list[AppRunConfig]:
         """
-        Creates 3 copies of the input and configures them for 3 different app parameters.
+        Creates 3 copies of the input and configures them for 3 different app options.
         """
 
         inputs = [copy.deepcopy(data) for _ in range(3)]

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/docs/tutorials/getting-started.md

@@ -185,6 +185,51 @@ def merge(results: list[dict]):
     return merged_result
 ```
 
+### Dynamically customizing App Runs
+
+!!! tip "Reference"
+
+    Find the reference for the `AppRunConfig` class [here](../reference/config.md##nextpipe.schema.AppRunConfig).
+
+The `AppRunConfig` class allows you to dynamically customize app runs.
+Particularly, when fanning out steps using the `@foreach` decorator, you can
+pass a list of `AppRunConfig` objects to specify different configurations for
+each run:
+
+```python
+from nextpipe.schema import AppRunConfig
+
+@foreach()
+@step
+def create_scenarios(data: dict):
+    """Create multiple scenarios to solve with different configurations."""
+    return [
+        AppRunConfig(
+            name="scenario1",
+            input=data,
+            options={
+                "solve.duration": "5s",
+            },
+        ),
+        AppRunConfig(
+            name="scenario2",
+            input=data,
+            options={
+                "solve.duration": "10s",
+            },
+        ),
+    ]
+
+@needs(predecessors=[create_scenarios])
+@app(app_id="solver-app", instance_id="latest")
+@step
+def solve():
+    """Run external solver for each scenario."""
+    pass
+```
+
+The `AppRunConfig` will be applied to each run of the `solve` step.
+
 ## Output & visualization
 
 After running a `nextpipe` program, the output is composed of the following

nextpipe-0.3.2.dev0/nextpipe/__about__.py

@@ -0,0 +1 @@
+__version__ = "v0.3.2.dev0"

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/pyproject.toml

@@ -47,7 +47,7 @@ requires-python = ">=3.9"
 
 [project.urls]
 Homepage = "https://www.nextmv.io"
-Documentation = "https://www.nextmv.io/docs"
+Documentation = "https://nextpipe.docs.nextmv.io/en/latest/"
 Repository = "https://github.com/nextmv-io/nextpipe"
 
 [tool.ruff]

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/tests/pipelines/foreach-2-pred.py

@@ -12,7 +12,7 @@ class Flow(FlowSpec):
     @step
     def fanout(data: dict):
         """
-        Creates 3 copies of the input and configures them for 3 different app parameters.
+        Creates 3 copies of the input and configures them for 3 different app options.
         """
         inputs = [copy.deepcopy(data) for _ in range(3)]
         run_configs = [AppRunConfig(input, [AppOption("param", i)]) for i, input in enumerate(inputs)]

{nextpipe-0.3.0 → nextpipe-0.3.2.dev0}/tests/pipelines/foreach.py

@@ -12,7 +12,7 @@ class Flow(FlowSpec):
     @step
     def prepare(data: dict):
         """
-        Creates 3 copies of the input and configures them for 3 different app parameters.
+        Creates 3 copies of the input and configures them for 3 different app options.
         """
         inputs = [copy.deepcopy(data) for _ in range(3)]
         run_configs = [AppRunConfig(input, [AppOption("param", i)]) for i, input in enumerate(inputs)]

nextpipe-0.3.0/.github/workflows/release.yml

@@ -1,146 +0,0 @@
-name: release
-run-name: Release ${{ inputs.VERSION }} (pre-release - ${{ inputs.IS_PRE_RELEASE }}) by @${{ github.actor }} from ${{ github.ref_name }}
-
-on:
-  workflow_dispatch:
-    inputs:
-      VERSION:
-        description: "The version to release"
-        required: true
-      IS_PRE_RELEASE:
-        description: "It IS a pre-release"
-        required: true
-        default: false
-        type: boolean
-
-jobs:
-  bump: # This job is used to bump the version and create a release
-    runs-on: ubuntu-latest
-    env:
-      VERSION: ${{ inputs.VERSION }}
-      GH_TOKEN: ${{ github.token }}
-      SSH_AUTH_SOCK: /tmp/ssh_agent.sock
-    permissions:
-      contents: write
-    steps:
-      - name: set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: install dependencies
-        run: |
-          pip install --upgrade pip
-          pip install build hatch
-
-      - name: configure git with the bot credentials
-        run: |
-          mkdir -p ~/.ssh
-          ssh-keyscan github.com >> ~/.ssh/known_hosts
-          ssh-agent -a $SSH_AUTH_SOCK > /dev/null
-          ssh-add - <<< "${{ secrets.NEXTMVBOT_SSH_KEY }}"
-
-          echo "${{ secrets.NEXTMVBOT_SIGNING_KEY }}" > ~/.ssh/signing.key
-          chmod 600 ~/.ssh/signing.key
-
-          git config --global user.name "nextmv-bot"
-          git config --global user.email "tech+gh-nextmv-bot@nextmv.io"
-          git config --global gpg.format ssh
-          git config --global user.signingkey ~/.ssh/signing.key
-
-          git clone git@github.com:nextmv-io/nextpipe.git
-          cd nextpipe
-          git switch ${{ github.ref_name }}
-
-      - name: upgrade version with hatch
-        run: hatch version ${{ env.VERSION }}
-        working-directory: ./nextpipe
-
-      - name: bump version in requirements.txt
-        run: |
-          bash .nextmv/bump_requirements.sh ${{ env.VERSION }}
-        working-directory: ./nextpipe
-
-      - name: commit new version
-        run: |
-          git add --all
-          git commit -S -m "Bump version to $VERSION"
-          git push
-          git tag $VERSION
-          git push origin $VERSION
-        working-directory: ./nextpipe
-
-      - name: create release
-        run: |
-          PRERELEASE_FLAG=""
-          if [ ${{ inputs.IS_PRE_RELEASE }} = true ]; then
-            PRERELEASE_FLAG="--prerelease"
-          fi
-
-          gh release create $VERSION \
-          --verify-tag \
-          --generate-notes \
-          --title $VERSION $PRERELEASE_FLAG
-        working-directory: ./nextpipe
-
-      - name: ensure passing build
-        run: python -m build
-        working-directory: ./nextpipe
-
-  release: # This job is used to publish the release to PyPI/TestPyPI
-    runs-on: ubuntu-latest
-    needs: bump
-    strategy:
-      matrix:
-        include:
-          - target-env: pypi
-            target-url: https://pypi.org/p/nextpipe
-          - target-env: testpypi
-            target-url: https://test.pypi.org/p/nextpipe
-    environment:
-      name: ${{ matrix.target-env }}
-      url: ${{ matrix.target-url }}
-    permissions:
-      contents: read
-      id-token: write # This is required for trusted publishing to PyPI
-    steps:
-      - name: git clone ${{ github.ref_name }}
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.ref_name }}
-
-      - name: set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: install dependencies
-        run: |
-          pip install --upgrade pip
-          pip install build hatch
-
-      - name: build binary wheel and source tarball
-        run: python -m build
-
-      - name: Publish package distributions to PyPI
-        if: ${{ matrix.target-env == 'pypi' }}
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: ./dist
-
-      - name: Publish package distributions to TestPyPI
-        if: ${{ matrix.target-env == 'testpypi' }}
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          repository-url: https://test.pypi.org/legacy/
-          packages-dir: ./dist
-
-  notify:
-    runs-on: ubuntu-latest
-    needs: release
-    if: ${{ needs.release.result == 'success' && inputs.IS_PRE_RELEASE == false }}
-    steps:
-      - name: notify slack
-        run: |
-          export DATA="{\"text\":\"Release notification - nextpipe ${{ inputs.VERSION }} (see <https://github.com/nextmv-io/nextpipe/releases/${{ inputs.VERSION }}|release notes> / <https://pypi.org/project/nextpipe|PyPI>)\"}"
-          curl -X POST -H 'Content-type: application/json' --data "$DATA" ${{ secrets.SLACK_URL_MISSION_CONTROL }}

nextpipe-0.3.0/nextpipe/__about__.py

@@ -1 +0,0 @@
-__version__ = "v0.3.0"