Migrate automations to PDM (#4625)

* Migrate automations to PDM Signed-off-by: Olga Bulat <obulat@gmail.com> * Remove docs about loading .env automatically Signed-off-by: Olga Bulat <obulat@gmail.com> * Update actions-gh-pages Signed-off-by: Olga Bulat <obulat@gmail.com> * Update the version specifiers Signed-off-by: Olga Bulat <obulat@gmail.com> --------- Signed-off-by: Olga Bulat <obulat@gmail.com>
WordPress · Jul 22, 2024 · 2f30dc6 · 2f30dc6
1 parent 4a708c1
commit 2f30dc6
Show file tree

Hide file tree

Showing 7 changed files with 619 additions and 665 deletions.
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -1045,7 +1045,7 @@ jobs:
         run: python get_folder_differences.py
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: /tmp/gh-pages

diff --git a/automations/python/Pipfile b/automations/python/Pipfile
diff --git a/automations/python/Pipfile.lock b/automations/python/Pipfile.lock
diff --git a/automations/python/justfile b/automations/python/justfile
@@ -11,9 +11,9 @@ NO_COLOR := "\\033[0m"
 
 
 # Install dependencies
-install:
-    pipenv install --dev
+install *args:
+    pdm install {{ args }}
 
 # Run a script
 run script *args:
-    pipenv run {{ script }} {{ args }}
+    pdm run {{ script }} {{ args }}
diff --git a/automations/python/pdm.lock b/automations/python/pdm.lock
diff --git a/automations/python/pyproject.toml b/automations/python/pyproject.toml
@@ -0,0 +1,26 @@
+[project]
+name = "openverse-automations"
+version = "0.0.0"
+description = "Automations for the Openverse project"
+readme = "README.md"
+authors = [
+    {name = "Openverse Contributors", email = "openverse@wordpress.org"},
+]
+
+requires-python = "==3.12.*"
+dependencies = [
+    "pygithub >= 2.3.0, < 3",
+    "pyyaml >= 6.0.1, < 7",
+    "beautifulsoup4 >= 4.12.3, < 5",
+    "requests >= 2.32.3, < 3",
+    "mechanize >= 0.4.10, < 1",
+    "pyotp >= 2.9.0, < 3",
+]
+
+[tool.pdm]
+distribution = false
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "ipython",
+]
diff --git a/documentation/automations/guides/quickstart.md b/documentation/automations/guides/quickstart.md
@@ -13,7 +13,7 @@ Follow the [general setup guide](/general/general_setup.md) to set up `ov`.
 Node.js dependencies for automations as well as other parts of the repository.
 If you wish to install only dependencies for automations, run the following:
 
-- `ov pipenv install` in `automations/python`
+- `ov pdm install` in `automations/python`
 - `ov pnpm install --filter=automations`
 
 ## Running a Script
@@ -27,7 +27,7 @@ Ex.:
 ov just automations/python/run print_labels.py
 ```
 
-The recipe is an alias for running `ov pipenv run <script>` inside the
+The recipe is an alias for running `ov pdm run <script>` inside the
 `automations/python` directory. This facilitates correct `PYTHONPATH`
 configuration as expected by many scripts.
 
@@ -48,10 +48,6 @@ executable scripts available can also be run using the same recipe.
 Many Openverse automation scripts expect to run inside a GitHub actions context
 and require specific environment variables to operate. Refer to individual
 script documentation (or implementation when no module documentation exists) to
-know which environment variables are expected.
-[Pipenv automatically loads `.env` files](https://pipenv-fork.readthedocs.io/en/latest/advanced.html#automatic-loading-of-env)
-so for ease of use, you may place relevant environment variables in
-`automations/python/.env`. Unlike Pipenv, however, pnpm does _not_ automatically
-load environment variables. If a Node.js script requires environment variables,
-you must pass them yourself via the command line or use another method to make
-the variables available to the script.
+know which environment variables are expected. If a script requires environment
+variables, you must pass them yourself via the command line or use another
+method to make the variables available to the script.