diff --git a/.hatch_build.py b/.hatch_build.py index 9e8770e..d85b769 100644 --- a/.hatch_build.py +++ b/.hatch_build.py @@ -17,5 +17,5 @@ class MetaDataHook(MetadataHookInterface): def load_about() -> dict[str, str]: about: dict[str, str] = {} with open(os.path.join(HERE, "tutornotes", "__about__.py"), "rt", encoding="utf-8") as f: - exec(f.read(), about) # pylint: disable=exec-used + exec(f.read(), about) return about diff --git a/Makefile b/Makefile index 2bc273a..b8ae689 100644 --- a/Makefile +++ b/Makefile @@ -1,22 +1,31 @@ .DEFAULT_GOAL := help .PHONY: docs SRC_DIRS = ./tutornotes -BLACK_OPTS = --exclude templates ${SRC_DIRS} +RUFF_OPTS = --exclude templates ${SRC_DIRS} # Warning: These checks are run on every PR. -test: test-lint test-types test-format # Run some static checks. +test: test-lint test-types test-format test-pythonpackage test-format: ## Run code formatting tests. - black --check --diff $(BLACK_OPTS) + ruff format --check --diff $(RUFF_OPTS) -test-lint: ## Run code linting tests - pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS} +test-lint: + ruff check ${SRC_DIRS} test-types: ## Run type checks. mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS} +build-pythonpackage: + python -m build --sdist + +test-pythonpackage: build-pythonpackage + twine check dist/tutor_notes-$(shell make version).tar.gz + format: ## Format code automatically. - black $(BLACK_OPTS) + ruff format $(RUFF_OPTS) + +fix-lint: ## Fix linting issues automatically. + ruff check --fix $(RUFF_OPTS) isort: ## Sort imports. This target is not mandatory because the output may be incompatible with black formatting. Provided for convenience purposes. isort --skip=templates ${SRC_DIRS} @@ -27,6 +36,9 @@ changelog-entry: ## Create a new changelog entry. changelog: ## Collect changelog entries in the CHANGELOG.md file. scriv collect +version: ## Print the current tutor-notes version + @python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutornotes", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])' + ESCAPE =  help: ## Print this help. @grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \ diff --git a/changelog.d/20250915_115717_dawoud.sheraz_ruff_migration.md b/changelog.d/20250915_115717_dawoud.sheraz_ruff_migration.md new file mode 100644 index 0000000..114cde4 --- /dev/null +++ b/changelog.d/20250915_115717_dawoud.sheraz_ruff_migration.md @@ -0,0 +1,2 @@ +- [Improvement] Migrate from pylint and black to ruff. (by @dawoudsheraz) +- [Improvement] Test python package distribution build when running make-test. (by @dawoudsheraz) diff --git a/pyproject.toml b/pyproject.toml index a97b394..525d699 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,8 +36,7 @@ dynamic = ["version"] [project.optional-dependencies] dev = [ "tutor[dev]>=20.0.0,<21.0.0", - "black", - "pylint" + "ruff" ] @@ -69,3 +68,20 @@ exclude = ["tests*"] [project.entry-points."tutor.plugin.v1"] notes = "tutornotes.plugin" + +[tool.ruff] +exclude = ["templates", "docs/_ext"] + +[tool.ruff.lint] +# E: pycodestyle errors +# I: isort +# N: pep8-naming +select = ["E", "I", "N"] + +# F401: unused-import +# F841: unused-variable +# W292: missing-newline-at-end-of-file +extend-select = ["F401", "F841", "W292"] + +[tool.ruff.format] +# Default config is automatically taken from https://docs.astral.sh/ruff/configuration/ diff --git a/tutornotes/plugin.py b/tutornotes/plugin.py index b98f46b..3c6624c 100644 --- a/tutornotes/plugin.py +++ b/tutornotes/plugin.py @@ -17,7 +17,7 @@ if __version_suffix__: config = { "defaults": { "VERSION": __version__, - "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}", + "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-notes:{{ NOTES_VERSION }}", # noqa: E501 "HOST": "notes.{{ LMS_HOST }}", "MYSQL_DATABASE": "notes", "MYSQL_USERNAME": "notes",