apify 2.2.1b6__tar.gz → 3.0.5b8__tar.gz

apify-3.0.5b8/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+
+[Makefile]
+indent_style = tab
+
+[{*.yaml, *.yml}]
+indent_size = 2

apify-3.0.5b8/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Documentation codeowner
+
+/docs/*.md @TC-MO
+/docs/*.mdx @TC-MO

apify-3.0.5b8/.github/workflows/build_and_deploy_docs.yaml

@@ -0,0 +1,87 @@
+name: Build and deploy docs
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+env:
+  NODE_VERSION: 22
+  PYTHON_VERSION: 3.13
+
+jobs:
+  build_and_deploy_docs:
+    environment:
+      name: github-pages
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
+
+      - name: Set up Node
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: website/package-lock.json
+
+      - name: Install Node dependencies
+        run: |
+          npm install
+          npm update @apify/docs-theme
+        working-directory: ./website
+
+      # We do this as early as possible to prevent conflicts if someone else would push something in the meantime
+      - name: Commit the updated package.json and lockfile
+        run: |
+          git config user.name 'GitHub Actions'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git add website/package.json
+          git add website/package-lock.json
+          git diff-index --quiet HEAD || git commit -m 'chore: Automatic docs theme update [skip ci]' || true
+          git push
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Set up uv package manager
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Python dependencies
+        run: make install-dev
+
+      - name: Build generated API reference
+        run: make build-api-reference
+
+      - name: Build Docusaurus docs
+        run: make build-docs
+        env:
+          APIFY_SIGNING_TOKEN: ${{ secrets.APIFY_SIGNING_TOKEN }}
+
+      - name: Set up GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./website/build
+
+      - name: Deploy artifact to GitHub Pages
+        uses: actions/deploy-pages@v4
+
+      - name: Invalidate CloudFront cache
+        run: gh workflow run invalidate.yaml --repo apify/apify-docs-private
+        env:
+          GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}

apify-3.0.5b8/.github/workflows/check_pr_title.yaml

@@ -0,0 +1,14 @@
+name: Check PR title
+
+on:
+  pull_request_target:
+    types: [opened, edited, synchronize]
+
+jobs:
+  check_pr_title:
+    name: Check PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5.5.3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

apify-3.0.5b8/.github/workflows/pre_release.yaml

@@ -0,0 +1,90 @@
+name: Create a pre-release
+
+on:
+  # Trigger a beta version release (pre-release) on push to the master branch.
+  push:
+    branches:
+      - master
+    tags-ignore:
+      - "**" # Ignore all tags to prevent duplicate builds when tags are pushed.
+
+  # Or it can be triggered manually.
+  workflow_dispatch:
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release_metadata:
+    if: "!startsWith(github.event.head_commit.message, 'docs') && !startsWith(github.event.head_commit.message, 'ci') && startsWith(github.repository, 'apify/')"
+    name: Prepare release metadata
+    runs-on: ubuntu-latest
+    outputs:
+      version_number: ${{ steps.release_metadata.outputs.version_number }}
+      tag_name: ${{ steps.release_metadata.outputs.tag_name }}
+      changelog: ${{ steps.release_metadata.outputs.changelog }}
+    steps:
+      - uses: apify/workflows/git-cliff-release@main
+        id: release_metadata
+        name: Prepare release metadata
+        with:
+          release_type: prerelease
+          existing_changelog_path: CHANGELOG.md
+
+  lint_check:
+    name: Lint check
+    uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  type_check:
+    name: Type check
+    uses: apify/workflows/.github/workflows/python_type_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  unit_tests:
+    name: Unit tests
+    uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  integration_tests:
+    name: Integration tests
+    uses: apify/workflows/.github/workflows/python_integration_tests.yaml@main
+    secrets: inherit
+    with:
+      python-versions: '["3.10", "3.13"]'
+
+  update_changelog:
+    name: Update changelog
+    needs: [release_metadata, lint_check, type_check, unit_tests, integration_tests]
+    uses: apify/workflows/.github/workflows/python_bump_and_update_changelog.yaml@main
+    with:
+      version_number: ${{ needs.release_metadata.outputs.version_number }}
+      changelog: ${{ needs.release_metadata.outputs.changelog }}
+    secrets:
+      APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
+
+  publish_to_pypi:
+    name: Publish to PyPI
+    needs: [release_metadata, update_changelog]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write # Required for OIDC authentication.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/apify
+    steps:
+      - name: Prepare distribution
+        uses: apify/workflows/prepare-pypi-distribution@main
+        with:
+          package_name: apify
+          is_prerelease: "yes"
+          version_number: ${{ needs.release_metadata.outputs.version_number }}
+          ref: ${{ needs.update_changelog.outputs.changelog_commitish }}
+      # Publishes the package to PyPI using PyPA official GitHub action with OIDC authentication.
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

apify-3.0.5b8/.github/workflows/release.yaml

@@ -0,0 +1,124 @@
+name: Create a release
+
+on:
+  # Trigger a stable version release via GitHub's UI, with the ability to specify the type of release.
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: Release type
+        required: true
+        type: choice
+        default: auto
+        options:
+          - auto
+          - custom
+          - patch
+          - minor
+          - major
+      custom_version:
+        description: The custom version to bump to (only for "custom" type)
+        required: false
+        type: string
+        default: ""
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release_metadata:
+    name: Prepare release metadata
+    runs-on: ubuntu-latest
+    outputs:
+      version_number: ${{ steps.release_metadata.outputs.version_number }}
+      tag_name: ${{ steps.release_metadata.outputs.tag_name }}
+      changelog: ${{ steps.release_metadata.outputs.changelog }}
+      release_notes: ${{ steps.release_metadata.outputs.release_notes }}
+    steps:
+      - uses: apify/workflows/git-cliff-release@main
+        name: Prepare release metadata
+        id: release_metadata
+        with:
+          release_type: ${{ inputs.release_type }}
+          custom_version: ${{ inputs.custom_version }}
+          existing_changelog_path: CHANGELOG.md
+
+  lint_check:
+    name: Lint check
+    uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  type_check:
+    name: Type check
+    uses: apify/workflows/.github/workflows/python_type_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  unit_tests:
+    name: Unit tests
+    uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  update_changelog:
+    name: Update changelog
+    needs: [release_metadata, lint_check, type_check, unit_tests]
+    uses: apify/workflows/.github/workflows/python_bump_and_update_changelog.yaml@main
+    with:
+      version_number: ${{ needs.release_metadata.outputs.version_number }}
+      changelog: ${{ needs.release_metadata.outputs.changelog }}
+    secrets:
+      APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}
+
+  create_github_release:
+    name: Create github release
+    needs: [release_metadata, update_changelog]
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Create release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ needs.release_metadata.outputs.tag_name }}
+          name: ${{ needs.release_metadata.outputs.version_number }}
+          target_commitish: ${{ needs.update_changelog.outputs.changelog_commitish }}
+          body: ${{ needs.release_metadata.outputs.release_notes }}
+
+  publish_to_pypi:
+    name: Publish to PyPI
+    needs: [release_metadata, update_changelog]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write # Required for OIDC authentication.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/apify
+    steps:
+      - name: Prepare distribution
+        uses: apify/workflows/prepare-pypi-distribution@main
+        with:
+          package_name: apify
+          is_prerelease: ""
+          version_number: ${{ needs.release_metadata.outputs.version_number }}
+          ref: ${{ needs.update_changelog.outputs.changelog_commitish }}
+      # Publishes the package to PyPI using PyPA official GitHub action with OIDC authentication.
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  trigger_docker_build:
+    name: Trigger Docker image build
+    needs: [release_metadata, update_changelog]
+    runs-on: ubuntu-latest
+    steps:
+      - # Trigger building the Python Docker images in apify/apify-actor-docker repo
+        name: Trigger Docker image build
+        run: |
+          gh api -X POST "/repos/apify/apify-actor-docker/dispatches" \
+            -F event_type=build-python-images \
+            -F client_payload[release_tag]=latest \
+            -F client_payload[apify_version]=${{ needs.release_metadata.outputs.version_number }}
+        env:
+          GH_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}

apify-3.0.5b8/.github/workflows/run_code_checks.yaml

@@ -0,0 +1,43 @@
+name: Run code checks
+
+on:
+  # Trigger code checks on opening a new pull request.
+  # Secrets are only made available to the integration tests job, with a manual approval
+  # step required for PRs from forks. This prevents their potential exposure.
+  pull_request:
+
+  # Trigger for pushing to the master branch is handled by the pre-release workflow.
+
+  # It should also be possible to trigger checks manually
+  workflow_dispatch:
+
+jobs:
+  lint_check:
+    name: Lint check
+    uses: apify/workflows/.github/workflows/python_lint_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  type_check:
+    name: Type check
+    uses: apify/workflows/.github/workflows/python_type_check.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  unit_tests:
+    name: Unit tests
+    uses: apify/workflows/.github/workflows/python_unit_tests.yaml@main
+    with:
+      python-versions: '["3.10", "3.11", "3.12", "3.13"]'
+
+  docs_check:
+    name: Docs check
+    uses: apify/workflows/.github/workflows/python_docs_check.yaml@main
+    secrets: inherit
+
+  integration_tests:
+    name: Integration tests
+    uses: apify/workflows/.github/workflows/python_integration_tests.yaml@main
+    secrets: inherit
+    with:
+      python-versions: '["3.10", "3.13"]'

apify-3.0.5b8/.github/workflows/update_new_issue.yaml

@@ -0,0 +1,25 @@
+name: Update new issue
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  label_issues:
+    name: Label issues
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+      # Add the "t-tooling" label to all new issues
+      - uses: actions/github-script@v8
+        with:
+          script: |
+            github.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: ["t-tooling"]
+            })

apify-3.0.5b8/.gitignore

@@ -0,0 +1,49 @@
+# Cache
+__pycache__
+.mypy_cache
+.pytest_cache
+.ruff_cache
+
+# Virtual envs
+.venv
+.direnv
+.envrc
+.python-version
+
+# Mise
+mise.toml
+.mise.toml
+
+# Egg and build artifacts
+*.egg-info/
+*.egg
+dist/
+build/
+
+# Coverage reports
+.coverage*
+htmlcov
+
+# IDE, editors
+.vscode
+.idea
+.DS_Store
+.nvim.lua
+Session.vim
+
+# Docs
+docs/changelog.md
+
+# Website build artifacts, node dependencies
+website/build
+website/node_modules
+website/.yarn
+website/.docusaurus
+website/api-typedoc-generated.json
+website/apify-shared-docspec-dump.jsonl
+website/docspec-dump.jsonl
+website/module_shortcuts.json
+website/typedoc-types*
+
+# Default directory for memory storage
+storage/

apify-3.0.5b8/.markdownlint.yaml

@@ -0,0 +1,5 @@
+default: true
+line-length:
+  line_length: 150
+ul-style: dash
+no-inline-html: false

apify-3.0.5b8/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint-check
+        name: Lint check
+        entry: make lint
+        language: system
+        pass_filenames: false
+
+      - id: type-check
+        name: Type check
+        entry: make type-check
+        language: system
+        pass_filenames: false