diff --git a/.hatch_build.py b/.hatch_build.py index a5995de..2a91d02 100644 --- a/.hatch_build.py +++ b/.hatch_build.py @@ -18,5 +18,5 @@ def load_about() -> dict[str, str]: with open( os.path.join(HERE, "tutordiscovery", "__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 5bda776..2af4a0b 100644 --- a/Makefile +++ b/Makefile @@ -1,16 +1,15 @@ .DEFAULT_GOAL := help .PHONY: docs SRC_DIRS = ./tutordiscovery ./tests -BLACK_OPTS = --exclude templates ${SRC_DIRS} # Warning: These checks are run on every PR. -test: test-lint test-types test-format test-unit # Run some static checks. +test: test-lint test-types test-format test-unit test-pythonpackage # Run some static checks. test-format: ## Run code formatting tests. - black --check --diff $(BLACK_OPTS) + ruff format --check --diff ${SRC_DIRS} test-lint: ## Run code linting tests - pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS} + ruff check ${SRC_DIRS} test-types: ## Run type checks. mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS} @@ -18,11 +17,17 @@ test-types: ## Run type checks. test-unit: ## Run unit tests python -m unittest discover tests -format: ## Format code automatically. - black $(BLACK_OPTS) +build-pythonpackage: ## Build the "tutor-discovery" python package for upload to pypi + python -m build --sdist -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} +test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi + twine check dist/tutor_discovery-$(shell make version).tar.gz + +format: ## Format code automatically. + ruff format ${SRC_DIRS} + +fix-lint: ## Fix lint errors automatically + ruff check --fix ${SRC_DIRS} changelog-entry: ## Create a new changelog entry. scriv create @@ -30,6 +35,9 @@ changelog-entry: ## Create a new changelog entry. changelog: ## Collect changelog entries in the CHANGELOG.md file. scriv collect +version: ## Print the current tutor-discovery version + @python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutordiscovery", "__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/20250808_142901_muhammad.labeeb_release.md b/changelog.d/20250808_142901_muhammad.labeeb_release.md new file mode 100644 index 0000000..7d482d7 --- /dev/null +++ b/changelog.d/20250808_142901_muhammad.labeeb_release.md @@ -0,0 +1,2 @@ +- [Improvement] Migrate from pylint and black to ruff. (by @mlabeeb03) +- [Improvement] Test python package distribution build when running make test. (by @mlabeeb03) \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index fb61078..d4bad74 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,8 +35,7 @@ dynamic = ["version"] [project.optional-dependencies] dev = [ "tutor[dev]>=20.0.0,<21.0.0", - "pylint", - "black" + "ruff", ] # https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels @@ -65,5 +64,21 @@ exclude = ["tests*"] [tool.hatch.build.targets.wheel] packages = ["tutordiscovery"] +[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] + [project.entry-points."tutor.plugin.v1"] discovery = "tutordiscovery.plugin" diff --git a/tests/test_utils.py b/tests/test_utils.py index 0a2f766..6d62121 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -20,7 +20,7 @@ class UtilsTests(unittest.TestCase): @patch("subprocess.run") def test_is_docker_rootless_podman(self, mock_run: MagicMock) -> None: - """Test the `is_docker_rootless` when podman is used or any other error with `docker info`""" + """Test the `is_docker_rootless` when podman is used or any other error with `docker info`""" # noqa: E501 utils.is_docker_rootless.cache_clear() mock_run.side_effect = subprocess.CalledProcessError(1, "docker info") self.assertFalse(utils.is_docker_rootless()) diff --git a/tutordiscovery/plugin.py b/tutordiscovery/plugin.py index a1a58fc..26bf367 100644 --- a/tutordiscovery/plugin.py +++ b/tutordiscovery/plugin.py @@ -22,7 +22,7 @@ APP_NAME = "discovery" config: t.Dict[str, t.Dict[str, t.Any]] = { "defaults": { "VERSION": __version__, - "DOCKER_IMAGE": "{{ DOCKER_REGISTRY}}overhangio/openedx-discovery:{{ DISCOVERY_VERSION }}", + "DOCKER_IMAGE": "{{ DOCKER_REGISTRY}}overhangio/openedx-discovery:{{ DISCOVERY_VERSION }}", # noqa: E501 "HOST": "discovery.{{ LMS_HOST }}", "INDEX_OVERRIDES": {}, "MYSQL_DATABASE": "discovery",