initial release

Author: gasse

.github/workflows/pypi.yml

@@ -0,0 +1,112 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: [push, workflow_dispatch]
+
+jobs:
+    build:
+      name: Build
+      runs-on: ubuntu-latest
+
+      steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install pypa/build
+        run: python3 -m pip install build --user
+
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build . --outdir dist/
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+    publish-to-pypi:
+      name: Publish to PyPI
+      if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+      needs:
+        - build
+      runs-on: ubuntu-latest
+      environment: pypi
+      permissions:
+        id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+      steps:
+        - name: Download all the distribution packages
+          uses: actions/download-artifact@v4
+          with:
+            name: python-package-distributions
+            path: dist/
+
+        - name: Publish all distribution packages to PyPI
+          uses: pypa/gh-action-pypi-publish@release/v1
+
+    github-release:
+      name: Sign with Sigstore and upload them to GitHub Release
+      needs:
+      - publish-to-pypi
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write  # IMPORTANT: mandatory for making GitHub Releases
+        id-token: write  # IMPORTANT: mandatory for sigstore
+
+      steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v1.2.3
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes ""
+
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'
+
+    # publish-to-testpypi:
+    #   name: Publish to TestPyPI
+    #   needs:
+    #   - build
+    #   runs-on: ubuntu-latest
+    #   environment: testpypi
+    #   permissions:
+    #     id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    #   steps:
+    #   - name: Download all the distribution packages
+    #     uses: actions/download-artifact@v4
+    #     with:
+    #       name: python-package-distributions
+    #       path: dist/
+
+    #   - name: Publish distribution packages to TestPyPI
+    #     uses: pypa/gh-action-pypi-publish@release/v1
+    #     with:
+    #       repository-url: https://test.pypi.org/legacy/

README.md

@@ -0,0 +1,42 @@
+<img src="./banner.png" />
+
+`WorkArena` is a suite of browser-based tasks designed for ServiceNow products, acting as a benchmark for automating commonly conducted activities within the product environment.
+
+## Setup
+
+### ServiceNow Instance
+
+1. Go to https://developer.servicenow.com/ and create an account
+2. Request a Utah developer instance (initializing it might take a while)
+3. Log into your ServiceNow instance via the browser and change the admin password if instructed to do so. If you're already registered in the instance, you can find the instance information (Username, Password, instance URL) in the `My Instances` section of your developer account.
+4. Set the following environment variables:
+    * `SNOW_INSTANCE_URL`: URL of your ServiceNow developer instance
+    * `SNOW_INSTANCE_UNAME`: username for your instance (usually `admin`)
+    * `SNOW_INSTANCE_PWD`: password for your instance (you'll receive this by email and you can get it from your ServiceNow developer account)
+
+To set environment variables in Bash, you can use the `export` command. Here's an example:
+
+```
+export SNOW_INSTANCE_URL="https://your-instance-url.service-now.com"
+export SNOW_INSTANCE_UNAME="your-username"
+export SNOW_INSTANCE_PWD="your-password"
+```
+
+Another option is to add the environment variables to your conda environment. To do this, you can execute the following command :
+
+```
+conda env config vars set ENV_VAR=VALUE
+```
+
+### Install Data
+
+Run the following code to install all the data shipped with the benchmark:
+
+```
+from browsergym.workarena.install import setup
+setup()
+```
+
+### Finally
+
+1. Run `pytest -v .` to make sure that your setup works.