Basic repository setup (#1)

.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

.github/CODEOWNERS

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

.github/workflows/check_version_availability.yaml

@@ -0,0 +1,28 @@
+name: Check package version availability
+
+on:
+  workflow_call:
+
+jobs:
+  check_version_availability:
+    name: Check version availability
+    runs-on: ubuntu-latest
+    if: (!startsWith(github.event.pull_request.title, 'docs:'))
+
+    steps:
+      # We need to check out the head commit in case of PRs, and the default ref otherwise (during release).
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: "${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || '' }}"
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Check version availability
+        run: make check-version-availability

.github/workflows/docs.yaml

@@ -0,0 +1 @@
+# TODO

.github/workflows/integration_tests.yaml

@@ -0,0 +1 @@
+# TODO

.github/workflows/lint_and_type_checks.yaml

@@ -0,0 +1,33 @@
+name: Lint and type checks
+
+on:
+  workflow_call:
+
+jobs:
+  lint_and_type_checks:
+    name: Lint and type checks
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      # We need to check out the head commit in case of PRs, and the default ref otherwise (during release).
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: "${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || '' }}"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Run lint
+        run: make lint
+
+      - name: Run type checks
+        run: make type-check

.github/workflows/release.yaml

@@ -0,0 +1,143 @@
+name: Check & Release
+
+on:
+  # Push to master will publish a beta version
+  push:
+    branches:
+      - master
+    tags-ignore:
+      - "**"
+  # A release via GitHub releases will publish a stable version
+  release:
+    types: [published]
+  # Workflow dispatch will publish whatever you choose
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: Release type
+        required: true
+        type: choice
+        default: alpha
+        options:
+          - alpha
+          - beta
+          - final
+
+jobs:
+  should_release:
+    name: Check whether to release
+    if: (!startsWith(github.event.head_commit.message, 'docs:') || github.event_name == 'workflow_dispatch')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dummy step
+        run: true
+
+  lint_and_type_checks:
+    name: Run lint and type_checks
+    needs: [should_release]
+    uses: ./.github/workflows/lint_and_type_checks.yaml
+
+  unit_tests:
+    name: Run unit tests
+    needs: [should_release]
+    uses: ./.github/workflows/unit_tests.yaml
+
+  integration_tests:
+    name: Run integration tests
+    needs: [should_release]
+    uses: ./.github/workflows/integration_tests.yaml
+    secrets: inherit
+
+  publish_to_pypi:
+    name: Publish to PyPI
+    needs: [should_release, lint_and_type_checks, unit_tests, integration_tests]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    environment:
+      name: pypi
+      url: https://pypi.org/p/apify
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - # Determine if this is a prerelease or latest release
+        name: Determine release type
+        id: get-release-type
+        run: |
+          if [ ${{ github.event_name }} = release ]; then
+            release_type="final"
+          elif [ ${{ github.event_name }} = push ]; then
+            release_type="beta"
+          elif [ ${{ github.event_name }} = workflow_dispatch ]; then
+            release_type=${{ github.event.inputs.release_type }}
+          fi
+
+          if [ ${release_type} = final ]; then
+            docker_image_tag="latest"
+          elif [ ${release_type} = beta ]; then
+            docker_image_tag="beta"
+          else
+            docker_image_tag=""
+          fi
+
+          echo "release_type=${release_type}" >> $GITHUB_OUTPUT
+          echo "docker_image_tag=${docker_image_tag}" >> $GITHUB_OUTPUT
+
+      - # Check whether the released version is listed in CHANGELOG.md
+        name: Check whether the released version is listed in the changelog
+        if: steps.get-release-type.outputs.release_type != 'alpha'
+        run: make check-changelog-entry
+
+      - # Check version consistency and increment pre-release version number for prereleases (must be the last step before build)
+        name: Bump pre-release version
+        if: steps.get-release-type.outputs.release_type != 'final'
+        run: python ./scripts/update_version_for_prerelease.py ${{ steps.get-release-type.outputs.release_type }}
+
+      - # Build a source distribution and a python3-only wheel
+        name: Build distribution files
+        run: make build
+
+      - # Check whether the package description will render correctly on PyPI
+        name: Check package rendering on PyPI
+        run: make twine-check
+
+      - # Publish package to PyPI using their official GitHub action
+        name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - # Tag the current commit with the version tag if this is not made from the release event (releases are tagged with the release process)
+        name: Tag Version
+        if: github.event_name != 'release'
+        run: |
+          git_tag=v`python ./scripts/print_current_package_version.py`
+          git tag $git_tag
+          git push origin $git_tag
+
+      - # Upload the build artifacts to the release
+        name: Upload the build artifacts to release
+        if: github.event_name == 'release'
+        run: gh release upload ${{ github.ref_name }} dist/*
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - # Trigger building the Python Docker images in apify/apify-actor-docker repo
+        name: Trigger Docker image build
+        run: |
+          PACKAGE_VERSION=`python ./scripts/print_current_package_version.py`
+          gh api -X POST "/repos/apify/apify-actor-docker/dispatches" \
+            -F event_type=build-python-images \
+            -F client_payload[release_tag]=${{ steps.get-release-type.outputs.docker_image_tag }} \
+            -F client_payload[apify_version]=$PACKAGE_VERSION
+        env:
+          GH_TOKEN: ${{ secrets.APIFY_SERVICE_ACCOUNT_GITHUB_TOKEN }}

.github/workflows/run_checks.yaml

@@ -0,0 +1,49 @@
+name: Code quality checks
+
+on:
+  pull_request_target:
+
+jobs:
+  check_version_availability:
+    name: Check version availability
+    uses: ./.github/workflows/check_version_availability.yaml
+
+  lint_and_type_checks:
+    name: Run lint and type checks
+    uses: ./.github/workflows/lint_and_type_checks.yaml
+
+  unit_tests:
+    name: Run unit tests
+    needs: [lint_and_type_checks]
+    uses: ./.github/workflows/unit_tests.yaml
+
+  # If the PR comes from the main repo, run integration tests directly
+  integration_tests:
+    if: github.event.pull_request.head.repo.owner.login == 'apify'
+    name: Run integration tests
+    needs: [lint_and_type_checks, unit_tests]
+    uses: ./.github/workflows/integration_tests.yaml
+    secrets: inherit
+
+  # If the PR comes from a fork,
+  # we need to approve running the workflow first before allowing it to run,
+  # so that we can check for any unauthorized access to our secrets.
+  # We need two workflow jobs for that,
+  # because jobs calling reusable workflows can't use an environment.
+  # The first job is a dummy job that just asks for approval to use the `fork-worklows` environment.
+  integration_tests_fork_approve:
+    if: github.event.pull_request.head.repo.owner.login != 'apify'
+    name: Approve integration tests from fork
+    needs: [lint_and_type_checks, unit_tests]
+    environment: fork-pr-integration-tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dummy step
+        run: true
+
+  # The second job is the actual integration tests job.
+  integration_tests_fork:
+    name: Run integration tests from fork
+    needs: [integration_tests_fork_approve]
+    uses: ./.github/workflows/integration_tests.yaml
+    secrets: inherit

.github/workflows/unit_tests.yaml

@@ -0,0 +1,32 @@
+name: Unit tests
+
+on:
+  workflow_call:
+
+jobs:
+  unit_tests:
+    name: Run unit tests
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # We need to check out the head commit in case of PRs,
+      # and the default ref otherwise (during release).
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: "${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || '' }}"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: make install-dev
+
+      - name: Run unit tests
+        run: make unit-tests

.gitignore

@@ -0,0 +1,22 @@
+__pycache__
+.mypy_cache
+.pytest_cache
+.ruff_cache
+
+.venv
+.direnv
+.envrc
+.python-version
+
+*.egg-info/
+*.egg
+dist/
+build/
+.coverage*
+htmlcov
+
+.vscode
+.idea
+.DS_Store
+
+docs/changelog.md

.markdownlint.yaml

@@ -0,0 +1,8 @@
+default: true
+line-length:
+  line_length: 120
+MD007:
+  indent: 4
+MD004:
+  style: dash
+no-inline-html: false

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint
+        name: Lint codebase
+        entry: make lint
+        language: system
+        pass_filenames: false
+
+      - id: type-check
+        name: Type-check codebase
+        entry: make type-check
+        language: system
+        pass_filenames: false
+
+      - id: unit-tests
+        name: Run unit tests
+        entry: make unit-tests
+        language: system
+        pass_filenames: false
+
+      - id: check-changelog
+        name: Check whether current version is mentioned in changelog
+        entry: make check-changelog-entry
+        language: system
+        pass_filenames: false

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.0.1](../../releases/tag/v0.0.1) - Unreleased
+
+...