Merge branch 'main' into lukeruud-patch-1

Author: ginic

CHANGELOG.md

@@ -9,6 +9,7 @@ You should also add project tags for each release in Github, see [Managing relea
 ## [Unreleased]
 ### Added
 - Added example auto-built Sphinx documentation in the `docs` folder
+- Github workflow for running ruff linter
 ### Changed
 - All build and packaging switched to use only pyproject.toml
 - Minimum python version changed to 3.10

pyproject.toml

@@ -34,7 +34,7 @@ test = ["pytest"]
 
 # Dependencies that are useful only to developers, like an autoformatter and support for visualizations in jupyter notebooks go here
 dev = [
-    "black",
+    "ruff",
     "jupyter",
     "matplotlib",
     "seaborn",

src/cdstemplate/__init__.py

@@ -1,8 +0,0 @@
-# Avoid RuntimeWarnings about double imports when executing scripts, see https://stackoverflow.com/questions/43393764/python-3-6-project-structure-leads-to-runtimewarning
-import sys
-
-if not "-m" in sys.argv:
-    from . import corpus_counter_script
-    from . import word_count
-    from . import utils
-

tests/test_word_count.py

@@ -48,7 +48,7 @@ def test_corpus_counter_init():
     cc = word_count.CorpusCounter()
     assert cc.doc_counter == 0
     assert cc.get_token_count("word") == 0
-    assert cc.case_insensitive == False
+    assert not cc.case_insensitive
     assert cc.tokenization_pattern == r"\s"