0.2.0

.github/workflows/ci.yml

@@ -1,53 +1,55 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-
 name: CI
 
 on:
   push:
-    branches: [ main ]
+    branches: ["*"]
   pull_request:
-    branches: [ main ]
+    branches: ["main"]
+  workflow_dispatch:
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install --with ci
+
+      - name: Run pre-commit
+        run: poetry run pre-commit run --all-files
 
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
-
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     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 dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install poetry
-        poetry install -v
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    # - name: Static type checks with mypy
-    #   run: |
-    #     poetry run mypy wordsiv/
-    - name: Test with pytest outputting coverage
-      run: |
-        poetry run coverage run --source=. -m pytest --doctest-modules --ignore scripts
-    - name: Upload to coveralls
-      run: |
-        poetry run coveralls --service=github
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    - name: Show diff w/ black
-      run: |
-        poetry run black --diff wordsiv/
-    - name: Test out README.md examples
-      run: |
-        bash tests/run_byexample.sh
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install --with ci
+
+      - name: Run pytest
+        run: poetry run pytest
+
+      - name: Run coverage
+        run: poetry run pytest --cov-report term-missing --cov=wordsiv tests/ --ignore=tests/test_snippets.py

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: docs
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocstrings-python
+      - run: mkdocs gh-deploy --force

.gitignore

@@ -7,4 +7,4 @@ prof/
 .DS_Store
 .venv*/
 _build/
-_static/
+_static/

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.8.4
+    hooks:
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format

.vscode/launch.json

@@ -9,4 +9,4 @@
             "console": "integratedTerminal"
         }
     ]
-}
+}

.vscode/settings.json

@@ -19,4 +19,4 @@
             80
         ]
     }
-}
+}

LICENSE

@@ -1,3 +1,7 @@
+This repository is licensed under the MIT License (see below), EXCEPT for *.tsv
+files in wordsiv/vocab_data. Each .tsv file is licensed by its corresponding
+*_meta.json file. Example: the license for en_books.tsv is in en_books_meta.json
+
 MIT License
 
 Copyright (c) 2021 Christopher Pauley