refactor project to use poetry and pytest

.github/workflows/check_duplicates.yml

@@ -0,0 +1,24 @@
+name: Check for Duplicate Facts
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  checkduplicates:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check for duplicate facts
+        run: |
+          cd tests/checkduplicates
+          cargo run --release

.github/workflows/main.yml

@@ -16,28 +16,80 @@ on:
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   test:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
-
-      # Runs a set of commands using the runners shell
-      - name: Run a multi-line script
-        run: |
-          pip3 install setuptools wheel
-          python3 setup.py sdist
-          pip3 install dist/*
-          python3 tests/test.py
-  checkduplicates:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Run a multi-line script
-        run: |
-          pip3 install -U setuptools wheel pip
-          pip3 install rapidfuzz tqdm
-          python3 tests/checkduplicates.py
+  name: Test code and coverage
+  runs-on: ubuntu-latest
+  strategy:
+    fail-fast: false
+    matrix:
+      python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+  steps:
+    - uses: actions/checkout@v4
+
+    # If you wanted to use multiple Python versions, you'd have specify a matrix in the job and
+    # reference the matrixe python version here.
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+
+    # Cache the installation of Poetry itself, e.g. the next step. This prevents the workflow
+    # from installing Poetry every time, which can be slow. Note the use of the Poetry version
+    # number in the cache key, and the "-0" suffix: this allows you to invalidate the cache
+    # manually if/when you want to upgrade Poetry, or if something goes wrong. This could be
+    # mildly cleaner by using an environment variable, but I don't really care.
+    - name: cache poetry install
+      uses: actions/cache@v4
+      with:
+        path: ~/.local
+        key: poetry-1.1.12-0
+
+    # Install Poetry. You could do this manually, or there are several actions that do this.
+    # `snok/install-poetry` seems to be minimal yet complete, and really just calls out to
+    # Poetry's default install script, which feels correct. I pin the Poetry version here
+    # because Poetry does occasionally change APIs between versions and I don't want my
+    # actions to break if it does.
+    #
+    # The key configuration value here is `virtualenvs-in-project: true`: this creates the
+    # venv as a `.venv` in your testing directory, which allows the next step to easily
+    # cache it.
+    - uses: snok/install-poetry@v1
+      with:
+        version: 1.5.1
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+
+    # Cache your dependencies (i.e. all the stuff in your `pyproject.toml`). Note the cache
+    # key: if you're using multiple Python versions, or multiple OSes, you'd need to include
+    # them in the cache key. I'm not, so it can be simple and just depend on the poetry.lock.
+    - name: cache deps
+      id: cache-deps
+      uses: actions/cache@v4
+      with:
+        path: .venv
+        key: pydeps-${{ hashFiles('**/poetry.lock') }}
+
+    # Install dependencies. `--no-root` means "install all dependencies but not the project
+    # itself", which is what you want to avoid caching _your_ code. The `if` statement
+    # ensures this only runs on a cache miss.
+    - run: poetry install --no-interaction --no-root
+      if: steps.cache-deps.outputs.cache-hit != 'true'
+
+    # Now install _your_ project. This isn't necessary for many types of projects -- particularly
+    # things like Django apps don't need this. But it's a good idea since it fully-exercises the
+    # pyproject.toml and makes that if you add things like console-scripts at some point that
+    # they'll be installed and working.
+    - run: poetry install --no-interaction
+
+    # run the tests and check for 100% coverage
+    - run: poetry run pytest . --cov=randfacts --cov-report=term-missing --cov-report=xml
+
+    # check for code style errors
+    - run: poetry run ruff check
+    # disable code format checking until docstrings are sorted out
+    # https://github.com/astral-sh/ruff/issues/8430
+    # - run: poetry run ruff format --check
+    - name: Upload coverage reports to Codecov
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,6 +1,3 @@
-# MacOS development (added by PancakesWasTaken)
-.DS_Store
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -97,7 +94,22 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 
 # Celery stuff
@@ -140,5 +152,19 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-# cargo
-Cargo.lock
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+