Adding Ruff Lint: adding missing docstrings, improving consistency, updating README

Author: philippesaade-wmde

.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

pyproject.toml

@@ -22,6 +22,7 @@ dev = [
 [tool.ruff]
 target-version = "py313"
 line-length = 120
+
 exclude = ["data/mysql"]
 
 [tool.ruff.lint]

src/WikidataLabel.py

@@ -39,7 +39,7 @@
 
 
 class WikidataLabel(Base):
-    """Database-backed cache for multilingual Wikidata labels."""
+    """Database cache for multilingual Wikidata labels."""
 
     __tablename__ = 'labels'
     id = Column(String(64), primary_key=True)
@@ -58,7 +58,7 @@ def initialize_database():
 
     @staticmethod
     def add_bulk_labels(data):
-        """Insert or update multiple label records in one transaction.
+        """Insert or update multiple label records.
 
         Args:
             data (list[dict]): Records containing at least ``id`` and ``labels`` keys.