document pypi package

.github/workflows/test and publish.yaml

@@ -9,38 +9,38 @@ permissions:
 jobs:
     build-and-test:
         runs-on: ubuntu-latest
+        container:
+            image: mcr.microsoft.com/playwright:v1.43.1
+            options: --user 1001
         steps:
-            - uses: actions/checkout@v2
-            - uses: actions/setup-node@v3
-              with:
-                  node-version: 16.9.1
-            - run: npm run setup
+            - uses: actions/checkout@v4
+            - run: npm ci
             - run: npm run check
             - name: upload compiled code
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               with:
                   name: build
                   path: dist
               env:
                   CI: true
             - name: upload playwright report
-              uses: actions/upload-artifact@v3
+              uses: actions/upload-artifact@v4
               if: always()
               with:
                   name: playwright-report
                   path: playwright-report/
                   retention-days: 30
-            - uses: actions/configure-pages@v3
+            - uses: actions/configure-pages@v5
               if: always()
             - name: Upload playwright report to github pages
-              uses: actions/upload-pages-artifact@v2
+              uses: actions/upload-pages-artifact@v3
               if: always()
               with:
                   path: playwright-report/
             - name: Deploy playwright report to Github Pages
               if: always()
               id: deployment
-              uses: actions/deploy-pages@v2
+              uses: actions/deploy-pages@v4
               with:
                   # this doesnt work yet so there can only be one deployed playwright report at a time across all PRs
                   # https://github.com/actions/deploy-pages/issues/180
@@ -60,16 +60,16 @@ jobs:
             packages: write
             pull-requests: read
         steps:
-            - uses: actions/checkout@v1
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
                   node-version: 16.9.1
             - run: echo ::set-output name=CURRENT_VERSION::$(node -p "require(\"./package.json\").version")
               id: current-version
             - if: github.ref == 'refs/heads/master'
               run: echo ::set-output name=VERSION_INFO::$(npm view $(node -p "require(\"./package.json\").name")@=${{ steps.current-version.outputs.CURRENT_VERSION }})
               id: version-was-changed
-            - uses: actions/download-artifact@v3
+            - uses: actions/download-artifact@v4
               # need to publish if the branch isn't master, or it is master and the version in package.json hasn't been published yet
               if: github.ref != 'refs/heads/master' || steps.version-was-changed.outputs.VERSION_INFO == ''
               with:

README.md

@@ -4,10 +4,20 @@ playwright [custom selector engines](https://playwright.dev/docs/extensibility#c
 
 ## installation
 
+### if using playwright for nodejs
+
 ```bash
 npm install playwright-ui5
 ```
 
+### if using playwright for python
+
+```bash
+uv add playwright-ui5-select
+```
+
+see the [playwright-ui5-select](https://github.com/JamesYFC/playwright-ui5-select) repo for usage instructions
+
 ## usage
 
 playwright-ui5 contains a selector engine for both css and xpath syntax. you can use whichever one you want, but the xpath one is more flexible since not all css selector syntax has been implemented yet.