2018-09-29 15:08:39 +00:00
|
|
|
|
.DEFAULT_GOAL := help
|
2020-01-10 14:30:09 +00:00
|
|
|
|
.PHONY: docs
|
2021-11-02 17:15:06 +00:00
|
|
|
|
SRC_DIRS = ./tutor ./tests ./bin
|
2019-06-06 19:58:21 +00:00
|
|
|
|
BLACK_OPTS = --exclude templates ${SRC_DIRS}
|
2018-09-29 15:08:39 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Development
|
|
|
|
|
|
2020-01-10 14:30:09 +00:00
|
|
|
|
docs: ## Build html documentation
|
|
|
|
|
$(MAKE) -C docs
|
|
|
|
|
|
2019-01-22 20:25:04 +00:00
|
|
|
|
compile-requirements: ## Compile requirements files
|
2020-01-10 14:38:17 +00:00
|
|
|
|
pip-compile requirements/base.in
|
|
|
|
|
pip-compile requirements/dev.in
|
|
|
|
|
pip-compile requirements/docs.in
|
|
|
|
|
|
|
|
|
|
upgrade-requirements: ## Upgrade requirements files
|
|
|
|
|
pip-compile --upgrade requirements/base.in
|
|
|
|
|
pip-compile --upgrade requirements/dev.in
|
|
|
|
|
pip-compile --upgrade requirements/docs.in
|
2020-06-21 11:47:14 +00:00
|
|
|
|
|
2021-11-02 17:15:06 +00:00
|
|
|
|
build-pythonpackage: build-pythonpackage-tutor ## Build python packages ready to upload to pypi
|
2021-07-06 07:42:57 +00:00
|
|
|
|
|
|
|
|
|
build-pythonpackage-tutor: ## Build the "tutor" python package for upload to pypi
|
2020-10-02 11:34:54 +00:00
|
|
|
|
python setup.py sdist
|
2021-07-06 07:42:57 +00:00
|
|
|
|
|
2021-03-17 17:19:43 +00:00
|
|
|
|
push-pythonpackage: ## Push python package to pypi
|
2021-06-25 15:03:43 +00:00
|
|
|
|
twine upload --skip-existing dist/tutor-$(shell make version).tar.gz
|
2020-10-02 11:34:54 +00:00
|
|
|
|
|
2021-02-25 08:09:14 +00:00
|
|
|
|
test: test-lint test-unit test-types test-format test-pythonpackage ## Run all tests by decreasing order or priority
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
|
|
|
|
test-format: ## Run code formatting tests
|
2019-06-03 10:23:05 +00:00
|
|
|
|
black --check --diff $(BLACK_OPTS)
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
|
|
|
|
test-lint: ## Run code linting tests
|
2021-04-06 09:58:04 +00:00
|
|
|
|
pylint --errors-only --enable=unused-import --ignore=templates ${SRC_DIRS}
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
2019-08-21 16:32:39 +00:00
|
|
|
|
test-unit: ## Run unit tests
|
2020-10-02 11:34:54 +00:00
|
|
|
|
python -m unittest discover tests
|
2019-03-23 23:16:03 +00:00
|
|
|
|
|
2021-02-25 08:09:14 +00:00
|
|
|
|
test-types: ## Check type definitions
|
|
|
|
|
mypy --exclude=templates --ignore-missing-imports --strict tutor/ tests/
|
|
|
|
|
|
2020-10-02 11:34:54 +00:00
|
|
|
|
test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi
|
2021-06-25 15:03:43 +00:00
|
|
|
|
twine check dist/tutor-$(shell make version).tar.gz
|
2019-06-19 10:02:28 +00:00
|
|
|
|
|
2019-05-05 09:40:49 +00:00
|
|
|
|
format: ## Format code automatically
|
2019-06-03 10:23:05 +00:00
|
|
|
|
black $(BLACK_OPTS)
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
2020-10-02 11:34:54 +00:00
|
|
|
|
bootstrap-dev: ## Install dev requirements
|
|
|
|
|
pip install .
|
|
|
|
|
pip install -r requirements/dev.txt
|
|
|
|
|
|
|
|
|
|
bootstrap-dev-plugins: bootstrap-dev ## Install dev requirement and all supported plugins
|
|
|
|
|
pip install -r requirements/plugins.txt
|
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Deployment
|
|
|
|
|
|
2019-01-22 20:25:04 +00:00
|
|
|
|
bundle: ## Bundle the tutor package in a single "dist/tutor" executable
|
2019-08-20 15:01:34 +00:00
|
|
|
|
pyinstaller tutor.spec
|
2019-02-24 19:14:25 +00:00
|
|
|
|
|
2021-05-17 13:39:46 +00:00
|
|
|
|
release: test release-unsafe ## Create a release tag and push it to origin
|
|
|
|
|
release-unsafe:
|
2021-03-17 15:45:01 +00:00
|
|
|
|
$(MAKE) release-tag release-push TAG=v$(shell make version)
|
|
|
|
|
release-tag:
|
2019-02-18 08:57:59 +00:00
|
|
|
|
@echo "=== Creating tag $(TAG)"
|
2019-02-18 08:22:41 +00:00
|
|
|
|
git tag -d $(TAG) || true
|
|
|
|
|
git tag $(TAG)
|
2021-03-17 15:45:01 +00:00
|
|
|
|
release-push:
|
2019-06-23 15:01:28 +00:00
|
|
|
|
@echo "=== Pushing tag $(TAG) to origin"
|
2020-06-21 11:47:14 +00:00
|
|
|
|
git push origin
|
2019-02-18 08:22:41 +00:00
|
|
|
|
git push origin :$(TAG) || true
|
|
|
|
|
git push origin $(TAG)
|
|
|
|
|
|
2021-05-17 13:39:46 +00:00
|
|
|
|
release-description: ## Write the current release description to a file
|
|
|
|
|
sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md > release_description.md
|
|
|
|
|
git log -1 --pretty=format:%b >> release_description.md
|
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Continuous integration tasks
|
|
|
|
|
|
2021-03-17 17:19:27 +00:00
|
|
|
|
pull-base-images: # Manually pull base images
|
|
|
|
|
docker image pull docker.io/ubuntu:20.04
|
|
|
|
|
docker image pull docker.io/python:3.7-alpine
|
|
|
|
|
|
2019-02-10 20:02:30 +00:00
|
|
|
|
ci-info: ## Print info about environment
|
2020-10-02 11:34:54 +00:00
|
|
|
|
python --version
|
|
|
|
|
pip --version
|
2019-06-23 20:46:41 +00:00
|
|
|
|
|
2020-10-02 11:34:54 +00:00
|
|
|
|
ci-test-bundle: ## Run basic tests on bundle
|
2020-07-01 07:21:45 +00:00
|
|
|
|
ls -lh ./dist/tutor
|
2019-03-18 16:26:37 +00:00
|
|
|
|
./dist/tutor --version
|
|
|
|
|
./dist/tutor config printroot
|
2019-06-05 17:45:22 +00:00
|
|
|
|
yes "" | ./dist/tutor config save --interactive
|
2019-07-03 14:09:33 +00:00
|
|
|
|
./dist/tutor config save
|
2020-01-14 12:32:45 +00:00
|
|
|
|
./dist/tutor plugins list
|
2021-10-25 17:32:13 +00:00
|
|
|
|
./dist/tutor plugins enable android discovery ecommerce forum license mfe minio notes richie webui xqueue
|
2020-01-14 12:32:45 +00:00
|
|
|
|
./dist/tutor plugins list
|
2020-09-17 10:53:14 +00:00
|
|
|
|
./dist/tutor license --help
|
2019-02-10 20:02:30 +00:00
|
|
|
|
|
2019-07-04 14:28:45 +00:00
|
|
|
|
ci-bootstrap-images:
|
2020-10-02 11:34:54 +00:00
|
|
|
|
pip install .
|
2019-07-04 09:26:10 +00:00
|
|
|
|
tutor config save
|
2019-04-22 13:14:46 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Additional commands
|
|
|
|
|
|
|
|
|
|
version: ## Print the current tutor version
|
|
|
|
|
@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutor", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
|
|
|
|
|
|
2018-09-29 15:22:55 +00:00
|
|
|
|
ESCAPE =
|
|
|
|
|
help: ## Print this help
|
|
|
|
|
@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
|
|
|
|
|
| sed 's/######* \(.*\)/\n $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' \
|
|
|
|
|
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
|