workflows, tests and requirements

.github/scripts/run-tests.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+set -e
+
+echo "Running tests..."
+python -m pytest
+echo "Tests passed!"

.github/workflows/tests.yml

@@ -0,0 +1,25 @@
+name: Tests
+on: 
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
+    steps:
+    - uses: actions/checkout@v3
+    - name: python ${{ matrix.python-version }} 
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }} 
+        cache: 'pip' # caching pip dependencies
+    - name: Install Python dependencies
+      uses: py-actions/py-dependency-install@v4
+    - name: Run pytest
+      run: ./.github/scripts/run-tests.sh
+      shell: bash

README.md

@@ -16,7 +16,9 @@ The spans produced have the following properties:
 
 ## Installation
 
-This package works with SpaCy v3
+This package works with:
+- python 3.7/3.8/3.9/3.10/3.11
+- spaCy>=3.0.0,<4.0.0, last tested on version 3.5
 
 With pip: `pip install spacy-dbpedia-spotlight`
 

requirements.txt

@@ -4,3 +4,4 @@ twine
 pylint
 pytest
 autopep8
+pytest

setup.cfg

@@ -8,7 +8,7 @@ author_email = [email protected]
 
 [options]
 install_requires =
-    spacy>=3
+    spacy>=3.0.0,<4.0.0
     loguru
 
 [options.entry_points]

tests/test_load_nlp.py

@@ -0,0 +1,17 @@
+import spacy
+
+def test_basic_load():
+    nlp = spacy.blank("en")
+    p = nlp.add_pipe('dbpedia_spotlight')
+    assert p != None
+    assert 'dbpedia_spotlight' in nlp.pipe_names
+
+def test_load_vector():
+    nlp = spacy.blank("en")
+    p = nlp.add_pipe('dbpedia_spotlight')
+    assert p != None
+    assert 'dbpedia_spotlight' in nlp.pipe_names
+    doc = nlp("Google LLC is an American multinational technology company.")
+    ents = doc.ents
+    assert ents is not None
+    assert len(ents) > 0