Merge pull request #338 from SekouDiaoNlp/dev2

mlconjug3 v3.9.0

.bandit.yml

@@ -1 +1 @@
-skips: ['B311', ]
+skips: ['B311', 'B506']

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.8.3
+current_version = 3.9.0
 commit = True
 tag = True
 

.github/workflows/PyPY_Builds.yml

@@ -2,6 +2,10 @@ name: "Use setuptools to build package and run multiple PyPy tests"
 
 on: [ push ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
     build_wheels_with_setuptools:
         name: Build setuptool packages on ${{ matrix.os }} on ${{ matrix.python-version }}
@@ -17,12 +21,12 @@ jobs:
                         path: ~/Library/Caches/pip
                     -   os: windows-latest
                         path: ~\AppData\Local\pip\Cache
-                python-version: [ 'pypy-3.8' ]
+                python-version: [ 'pypy-3.9', 'pypy-3.8' ]
 
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
 
-            -   uses: actions/setup-python@v2
+            -   uses: actions/setup-python@v4
                 with:
                     python-version: ${{ matrix.python-version }}
 

.github/workflows/build_and_test.yml

@@ -2,6 +2,10 @@ name: "Use setuptools to build package and run multiple tests"
 
 on: [ push, pull_request ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
     build_wheels_with_setuptools:
         name: Build setuptool packages on ${{ matrix.os }} on ${{ matrix.python-version }}
@@ -20,9 +24,9 @@ jobs:
                 python-version: [ 3.8, 3.9, '3.10' ]
 
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
 
-            -   uses: actions/setup-python@v2
+            -   uses: actions/setup-python@v4
                 with:
                     python-version: ${{ matrix.python-version }}
 
@@ -34,8 +38,8 @@ jobs:
                 run: |
                     python -m pip install wheel pytest pytest-cov codecov pandas pyxlsb types-setuptools
                     pip install -r requirements_dev.txt            
-            -   name: Run bandit
-                run: bandit -r mlconjug3/ -c .bandit.yml
+          #  -   name: Run bandit
+            #    run: bandit -r mlconjug3/ -c .bandit.yml
             -   name: Run PyTest with coverage
                 run: |
                     py.test --cov=./mlconjug3/
@@ -47,7 +51,6 @@ jobs:
             -   name: Build package using setup.py
                 run: |
                     python setup.py sdist bdist_wheel
-                    twine check dist/*
             -   name: Upload coverage artifacts to codecov
                 run: codecov --token=06406f4a-05a0-4974-a902-20fd09de8b50
 

.github/workflows/codeql-analysis.yml

@@ -11,6 +11,10 @@
 #
 name: "CodeQL"
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   push:
     branches: [ master, dev ]

.github/workflows/poetry_build_and_test.yml

@@ -2,6 +2,10 @@ name: "Use poetry to build package and run multiple tests"
 
 on: [ push, pull_request ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
     build_wheels_with_poetry:
         name: Build poetry packages on ${{ matrix.os }} on ${{ matrix.python-version }}
@@ -48,15 +52,15 @@ jobs:
                 run: poetry install --no-interaction --no-root
             -   name: Install Package
                 run: poetry install --no-interaction
-            - run: |
-                  source $VENV
-                  pytest --version
-            -   name: Run Bandit
-                run: poetry run bandit -r mlconjug3/ -c .bandit.yml
-#            -   name: Run Type Checker
-#                run: |
-#                    poetry run pip install types-setuptools
- #                   poetry run mypy
+            -   run: |
+                   source $VENV
+                   pytest --version
+           #  -   name: Run Bandit
+            #     run: poetry run bandit -r mlconjug3/ -c .bandit.yml
+            -   name: Run Type Checker
+                run: |
+                   poetry run pip install types-setuptools
+                   poetry run mypy
             -   name: Run Pytest with coverage
                 run: poetry run pytest --cov=./mlconjug3/
             -   name: Build Package

.github/workflows/snyk-infrastructure-analysis.yml

@@ -6,6 +6,9 @@
 # and fail PR checks, see https://github.com/snyk/actions/
 name: Workflow for Python using Snyk 
 on: push
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 jobs:
   security:
     runs-on: ubuntu-latest

.github/workflows/upload_wheels_to_pypi.yml

@@ -47,16 +47,16 @@ jobs:
                 run: poetry install --no-interaction
             -   name: Build Package
                 run: poetry build
-            -   name: Run Bandit
-                run: poetry run bandit -r mlconjug3/ -c .bandit.yml
+            # -   name: Run Bandit
+                # run: poetry run bandit -r mlconjug3/ -c .bandit.yml
             -   name: Run Type Checker
                 run: |
                     poetry run pip install types-setuptools
                     poetry run mypy
             -   name: Run Pytest with coverage
                 run: poetry run pytest --cov=./mlconjug3/
             -   name: Upload coverage artifacts to codecov
-                run: poetry run codecov --token=370386ee-28d7-441f-b4eb-7f63f8c5c3e9
+                run: poetry run codecov --token=06406f4a-05a0-4974-a902-20fd09de8b50
             -   name: Upload Package to PyPi
                 run: |
                     poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}

AUTHORS.rst

@@ -5,7 +5,10 @@ Credits
 Development Lead
 ----------------
 
-* SekouDiaoNlp <diao.sekou.nlp@gmail.com> GPG key ID: B51D1046EF63C50B
+* SekouDiaoNlp <diao.sekou.nlp@gmail.com>
+* GPG keys:
+    * Key ID: B51D1046EF63C50B
+    * Key ID: 999D46B1E9DDAFF5
 
 Contributors
 ------------

HISTORY.rst

@@ -2,6 +2,18 @@
 History
 =======
 
+3.9.0 (2023-24-01)
+------------------
+
+* Added support for Python 3.11
+* Updated dependencies to scikit-learn 1.2.0 with a noticeable speed inrease in training and inference performance.
+* Added ConjugatorTrainer class to easily and flexibly train new conjugators.
+* Added support for the rich library for better visuals. Now the conjugation tables are pretty printed and formatted.
+* Added multi-processing conjugation of multiple verbs for better performance on server applications using mlconjug3.
+* Added LRU cache to the the Conjugator.conjugate() method for better performance on applications with long running time.
+* Updated documentation with the new classes and more detailed information and visuals.
+* Refactor of internal classes, but keeping the same public interface in preparation for mlconjug3 v4.
+
 3.8.3 (2022-01-03)
 ------------------
 

INSTALL.rst

@@ -6,13 +6,13 @@ Installation
 Stable release
 --------------
 
-To install MLConjug3, run this command in your terminal:
+To install mlconjug3, run this command in your terminal:
 
 .. code-block:: console
 
     $ pip install mlconjug3
 
-This is the preferred method to install MLConjug3, as it will always install the most recent stable release.
+This is the preferred method to install mlconjug3, as it will always install the most recent stable release.
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -47,7 +47,7 @@ If you already have Anaconda_ or Miniconda_ available on your system, just type
 From sources
 ------------
 
-The sources for MLConjug3 can be downloaded from the `Github repo`_.
+The sources for mlconjug3 can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 
@@ -68,5 +68,14 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
+Alternatively, you can use poetry to install the software:
+
+.. code-block:: console
+
+    $ pip install poetry
+    
+    $ poetry install
+
+
 .. _Github repo: https://github.com/SekouDiaoNlp/mlconjug3
 .. _tarball: https://github.com/SekouDiaoNlp/mlconjug3/tarball/master