Modernize setup and supported versions

.github/workflows/build_and_test.yml

@@ -0,0 +1,35 @@
+name: jamspell build and test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install c++ dependencies
+        run: |
+          sudo apt-get install swig4.0 build-essential cmake libgtest-dev -y
+      - name: Install python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements_test.txt
+          mkdir build
+          cd build
+          cmake ..
+          make
+          ls -l
+          cd ..
+          python setup.py install
+      - name: Test with pytest
+        run: |
+          pytest -vv

.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: jamspell publish
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Verify that git tag matches version
+        run: python setup.py verify
+      - name: Install build deps
+        run: |
+          pip install -U pip
+          pip install build --user
+      - name: Create package
+        run: python -m build --sdist --wheel --outdir dist/ .
+      # FIXME: Deploy to pypi
+      - name: Deploy package to Gemfury
+        if: startsWith(github.ref, 'refs/tags')
+        run: |
+          pip install --user secretstorage twine
+          python ~/.local/bin/twine upload dist/* --repository-url https://push.fury.io/${{ secrets.FURY_ORGANIZATION }} -u ${{ secrets.FURY_PUSH_TOKEN }} -p ""

.gitignore

@@ -1,5 +1,4 @@
 .idea/
-*.txt
 *.pyc
 *.aff
 *.dic
@@ -10,3 +9,10 @@
 *.tar.gz
 *.spell
 *.cache
+
+*.egg-info/
+build/
+dist/
+jamspell.py
+*.so
+jamspell_wrap.cpp

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 2.8.12)
 project(jamspell)
 
 option(USE_BOOST_CONVERT "use Boost.Locale instead of std::codecvt for string conversion" OFF)

evaluate/evaluate.py

@@ -1,20 +1,22 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-import codecs
 import random
 import argparse
-import typo_model
 import time
 import copy
-from utils import normalize, loadText, generateSentences
-import utils
 
 try:
     import readline
 except:
     pass
 
+from evaluate import typo_model
+from evaluate import utils
+
+from .utils import normalize, loadText, generateSentences
+
+
 
 class STATE:
     NONE = 0
@@ -186,7 +188,7 @@ def evaluateCorrector(correctorName, corrector, originalSentences, erroredSenten
 
 def testMode(corrector):
     while True:
-        sentence = raw_input(">> ").lower().strip()
+        sentence = input(">> ").lower().strip()
         sentence = normalize(sentence).split()
         if not sentence:
             continue

evaluate/typo_model.py

@@ -3,8 +3,10 @@
 
 import random
 import bisect
+
 from scipy.stats import binom
-import utils
+
+from evaluate import utils
 
 # todo: calculate correct typo probabilities
 

jamspell/CMakeLists.txt

@@ -1,5 +1,5 @@
 
-add_library(jamspell_lib spell_corrector.cpp lang_model.cpp utils.cpp perfect_hash.cpp bloom_filter)
+add_library(jamspell_lib spell_corrector.cpp lang_model.cpp utils.cpp perfect_hash.cpp bloom_filter.cpp)
 target_link_libraries(jamspell_lib phf cityhash)
 
 if(Boost_FOUND)

requirements_test.txt

@@ -0,0 +1,2 @@
+scipy
+pytest

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description_file = README.md

setup.py

@@ -1,11 +1,9 @@
 import os
 import sys
-import re
 from distutils.command.build import build
 from distutils.command.build_ext import build_ext
 from setuptools.command.install import install
 from distutils.spawn import find_executable
-from distutils.version import LooseVersion
 from setuptools import setup
 from setuptools.extension import Extension
 import subprocess
@@ -26,7 +24,7 @@
         os.path.join('jamspell.i'),
     ],
     extra_compile_args=['-std=c++11', '-O2'],
-    swig_opts=['-c++'],
+    swig_opts=['-c++', '-py3'],
 )
 
 if sys.platform == 'darwin':
@@ -43,11 +41,11 @@ def run(self):
         self.run_command('build_ext')
         install.run(self)
 
-class Swig3Ext(build_ext):
+class Swig4Ext(build_ext):
     def find_swig(self):
-        swigBinary = find_executable('swig3.0') or find_executable('swig')
+        swigBinary = find_executable('swig4.0') or find_executable('swig')
         assert swigBinary is not None
-        assert subprocess.check_output([swigBinary, "-version"]).find(b'SWIG Version 3') != -1
+        assert subprocess.check_output([swigBinary, "-version"]).find(b'SWIG Version 4') != -1
         return swigBinary
 
 VERSION = '0.0.12'
@@ -63,16 +61,21 @@ def find_swig(self):
     long_description='context-based spell checker',
     keywords=['nlp', 'spell', 'spell-checker', 'jamspell'],
     classifiers=[
-        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'License :: OSI Approved :: MIT License',
     ],
+    python_requires='>=3.6',
     py_modules=['jamspell'],
     ext_modules=[jamspell],
     zip_safe=False,
     cmdclass={
         'build': CustomBuild,
         'install': CustomInstall,
-        'build_ext': Swig3Ext,
+        'build_ext': Swig4Ext,
     },
     include_package_data=True,
 )

test_jamspell.py

@@ -1,6 +1,8 @@
 import os
 import pytest
+from pytest import approx
 import jamspell
+
 from evaluate import generate_dataset
 from evaluate.evaluate import evaluateJamspell
 
@@ -39,4 +41,4 @@ def test_evaluation(sourceFile, alphabetFile, expected):
     generate_dataset.generateDatasetTxt(TEST_DATA + sourceFile, TEMP)
     trainLangModel(TEMP_TRAIN, alphabetFile, TEMP_MODEL)
     results = evaluateJamspell(TEMP_MODEL, TEMP_TEST, alphabetFile)
-    assert results == expected
+    assert results == approx(expected, rel=1)