diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 000000000..829f6137d --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,22 @@ +name: Run tests + +on: + pull_request: + branches: [master] + +jobs: + tests: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.8 + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Upgrade pip + run: python -m pip install --upgrade pip setuptools + - name: Install dependencies + run: | + pip install .[dev] + - name: Test lint, types, and format + run: make test diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..6e9bebb27 --- /dev/null +++ b/Makefile @@ -0,0 +1,34 @@ +.DEFAULT_GOAL := help +.PHONY: docs +SRC_DIRS = ./tutorindigo +BLACK_OPTS = --exclude templates ${SRC_DIRS} + +# Warning: These checks are not necessarily run on every PR. +test: test-lint test-types test-format # Run some static checks. + +test-format: ## Run code formatting tests + black --check --diff $(BLACK_OPTS) + +test-lint: ## Run code linting tests + pylint --errors-only --enable=unused-import,unused-argument --ignore=templates --ignore=docs/_ext ${SRC_DIRS} + +test-types: ## Run type checks. + mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS} + +format: ## Format code automatically + black $(BLACK_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} + +changelog-entry: ## Create a new changelog entry. + scriv create + +changelog: ## Collect changelog entries in the CHANGELOG.md file. + scriv collect + +ESCAPE =  +help: ## Print this help + @grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \ + | sed 's/######* \(.*\)/@ $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \ + | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}' diff --git a/README.rst b/README.rst index 7be345a38..42c5dac9b 100644 --- a/README.rst +++ b/README.rst @@ -15,7 +15,7 @@ Installation Indigo was specially developed to be used with `Tutor `__ (at least v14.0.0). If you have not installed Open edX with Tutor, then installation instructions will vary. -Since Tutor v13.2.0, Indigo can be installed as a Tutor plugin:: +Install and enable Indigo plugin:: tutor plugins install indigo tutor plugins enable indigo diff --git a/changelog.d/20231004_141354_codewithemad.md b/changelog.d/20231004_141354_codewithemad.md new file mode 100644 index 000000000..81ca4f19a --- /dev/null +++ b/changelog.d/20231004_141354_codewithemad.md @@ -0,0 +1 @@ +- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad) \ No newline at end of file diff --git a/setup.py b/setup.py index 3ce34dcf4..58c90f352 100644 --- a/setup.py +++ b/setup.py @@ -45,6 +45,7 @@ def load_about(): include_package_data=True, python_requires=">=3.8", install_requires=["tutor>=16.0.0,<17.0.0"], + extras_require={"dev": "tutor[dev]>=16.0.0,<17.0.0"}, entry_points={"tutor.plugin.v1": ["indigo = tutorindigo.plugin"]}, classifiers=[ "Development Status :: 5 - Production/Stable", diff --git a/tutorindigo/__about__.py b/tutorindigo/__about__.py index 1722f39b5..5e5e9109a 100644 --- a/tutorindigo/__about__.py +++ b/tutorindigo/__about__.py @@ -1,2 +1 @@ __version__ = "16.0.0" - diff --git a/tutorindigo/plugin.py b/tutorindigo/plugin.py index 39e6d3acf..d04ff6390 100644 --- a/tutorindigo/plugin.py +++ b/tutorindigo/plugin.py @@ -1,5 +1,6 @@ -import pkg_resources +import typing as t +import pkg_resources from tutor import hooks from tutor.__about__ import __version_suffix__ @@ -11,7 +12,7 @@ ################# Configuration -config = { +config: t.Dict[str, t.Dict[str, t.Any]] = { # Add here your new settings "defaults": { "VERSION": __version__,