requirements.txt lockfile for accessible reproducible environements

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on: [push, workflow_dispatch]
+
+jobs:
+  lock-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@94a823180e06fcde4ad29308721954a521c96ed0 # v4.4
+      - run: pdm lock --check
+  requirements-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@94a823180e06fcde4ad29308721954a521c96ed0 # v4.4
+      - run: pdm export -f requirements -o new_requirements.txt
+      - run: diff requirements.txt new_requirements.txt

README.md

@@ -17,9 +17,11 @@ sudo apt-get install libxml2-dev libxslt-dev python-dev
 ```bash
 python -m venv venv
 source venv/bin/activate
-pip install -e .
+pip install -r requirements.txt
 ```
 
+(Alternatively, if you have `pdm`, you can run `pdm sync`.)
+
 # How to run:
 
 ## 1 - Feature extraction