Skip to content
Snippets Groups Projects
makefile 610 B
Newer Older
MODULENAME = pk_optimizer
Tu, Ethan's avatar
Tu, Ethan committed

help:
	@echo ""
	@echo "Welcome to my project!!!"
	@echo "To get started create an environment using:"
	@echo "	make init"
	@echo "	conda activate ./envs"
	@echo ""
	@echo "To generate project documentation use:"
	@echo "	make doc"
	@echo ""
	@echo "To Lint the project use:"
	@echo "	make lint"
	@echo ""
	@echo "To run unit tests use:"
	@echo "	make test"
	@echo ""
	

init:
Tu, Ethan's avatar
Tu, Ethan committed
	conda env create --prefix ./envs --file REQUIREMENT.yml
Tu, Ethan's avatar
Tu, Ethan committed

doc:
	pdoc --force --html --output-dir ./docs $(MODULENAME)
Tu, Ethan's avatar
Tu, Ethan committed

lint:
	pylint $(MODULENAME)
Tu, Ethan's avatar
Tu, Ethan committed

test:
	pytest $(MODULENAME)
Tu, Ethan's avatar
Tu, Ethan committed

.PHONY: init doc lint test