Skip to content
Snippets Groups Projects
makefile 629 B
Newer Older
shawk masboob's avatar
shawk masboob committed
MODULENAME = Topological Machine Learning 

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:
	conda env create --prefix ./envs --file environment.yml

doc:
Gong, Mimi's avatar
Gong, Mimi committed
	pdoc3 --force --html --output-dir ./docs $(MODULENAME)
shawk masboob's avatar
shawk masboob committed

lint:
Gong, Mimi's avatar
Gong, Mimi committed
	pylint $(MODULENAME)
shawk masboob's avatar
shawk masboob committed

test:
Gong, Mimi's avatar
Gong, Mimi committed
	pytest $(MODULENAME) 
shawk masboob's avatar
shawk masboob committed

.PHONY: init doc lint test