mirror of
https://github.com/wassname/cookiecutter-data-science.git
synced 2026-08-11 11:16:48 +08:00
Isaac Slavitt
08d357c5fa
Official support for Python 2 ended on Jan 1, 2020 (see https://www.python.org/doc/sunset-python-2/ for more info). This change does not prevent anybody from using Python 2, but we should not be encouraging new projects to use it.
140 lines
4.4 KiB
Makefile
140 lines
4.4 KiB
Makefile
.PHONY: clean data lint requirements sync_data_to_s3 sync_data_from_s3
|
|
|
|
#################################################################################
|
|
# GLOBALS #
|
|
#################################################################################
|
|
|
|
PROJECT_DIR := $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
|
|
BUCKET = {{ cookiecutter.s3_bucket }}
|
|
PROFILE = {{ cookiecutter.aws_profile }}
|
|
PROJECT_NAME = {{ cookiecutter.repo_name }}
|
|
|
|
ifeq (,$(shell which conda))
|
|
HAS_CONDA=False
|
|
else
|
|
HAS_CONDA=True
|
|
endif
|
|
|
|
#################################################################################
|
|
# COMMANDS #
|
|
#################################################################################
|
|
|
|
## Install Python Dependencies
|
|
requirements: test_environment
|
|
python -m pip install -U pip setuptools wheel
|
|
python -m pip install -r requirements.txt
|
|
|
|
## Make Dataset
|
|
data: requirements
|
|
python src/data/make_dataset.py data/raw data/processed
|
|
|
|
## Delete all compiled Python files
|
|
clean:
|
|
find . -type f -name "*.py[co]" -delete
|
|
find . -type d -name "__pycache__" -delete
|
|
|
|
## Lint using flake8
|
|
lint:
|
|
flake8 src
|
|
|
|
## Upload Data to S3
|
|
sync_data_to_s3:
|
|
ifeq (default,$(PROFILE))
|
|
aws s3 sync data/ s3://$(BUCKET)/data/
|
|
else
|
|
aws s3 sync data/ s3://$(BUCKET)/data/ --profile $(PROFILE)
|
|
endif
|
|
|
|
## Download Data from S3
|
|
sync_data_from_s3:
|
|
ifeq (default,$(PROFILE))
|
|
aws s3 sync s3://$(BUCKET)/data/ data/
|
|
else
|
|
aws s3 sync s3://$(BUCKET)/data/ data/ --profile $(PROFILE)
|
|
endif
|
|
|
|
## Set up python interpreter environment
|
|
create_environment:
|
|
ifeq (True,$(HAS_CONDA))
|
|
@echo ">>> Detected conda, creating conda environment."
|
|
conda create --name $(PROJECT_NAME) python=3
|
|
@echo ">>> New conda env created. Activate with:\nsource activate $(PROJECT_NAME)"
|
|
else
|
|
python -m pip install -q virtualenv virtualenvwrapper
|
|
@echo ">>> Installing virtualenvwrapper if not already installed.\nMake sure the following lines are in shell startup file\n\
|
|
export WORKON_HOME=$$HOME/.virtualenvs\nexport PROJECT_HOME=$$HOME/Devel\nsource /usr/local/bin/virtualenvwrapper.sh\n"
|
|
@bash -c "source `which virtualenvwrapper.sh`;mkvirtualenv $(PROJECT_NAME) --python=python3"
|
|
@echo ">>> New virtualenv created. Activate with:\nworkon $(PROJECT_NAME)"
|
|
endif
|
|
|
|
## Test python environment is setup correctly
|
|
test_environment:
|
|
python test_environment.py
|
|
|
|
#################################################################################
|
|
# PROJECT RULES #
|
|
#################################################################################
|
|
|
|
|
|
|
|
#################################################################################
|
|
# Self Documenting Commands #
|
|
#################################################################################
|
|
|
|
.DEFAULT_GOAL := help
|
|
|
|
# Inspired by <http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html>
|
|
# sed script explained:
|
|
# /^##/:
|
|
# * save line in hold space
|
|
# * purge line
|
|
# * Loop:
|
|
# * append newline + line to hold space
|
|
# * go to next line
|
|
# * if line starts with doc comment, strip comment character off and loop
|
|
# * remove target prerequisites
|
|
# * append hold space (+ newline) to line
|
|
# * replace newline plus comments by `---`
|
|
# * print line
|
|
# Separate expressions are necessary because labels cannot be delimited by
|
|
# semicolon; see <http://stackoverflow.com/a/11799865/1968>
|
|
.PHONY: help
|
|
help:
|
|
@echo "$$(tput bold)Available rules:$$(tput sgr0)"
|
|
@echo
|
|
@sed -n -e "/^## / { \
|
|
h; \
|
|
s/.*//; \
|
|
:doc" \
|
|
-e "H; \
|
|
n; \
|
|
s/^## //; \
|
|
t doc" \
|
|
-e "s/:.*//; \
|
|
G; \
|
|
s/\\n## /---/; \
|
|
s/\\n/ /g; \
|
|
p; \
|
|
}" ${MAKEFILE_LIST} \
|
|
| LC_ALL='C' sort --ignore-case \
|
|
| awk -F '---' \
|
|
-v ncol=$$(tput cols) \
|
|
-v indent=19 \
|
|
-v col_on="$$(tput setaf 6)" \
|
|
-v col_off="$$(tput sgr0)" \
|
|
'{ \
|
|
printf "%s%*s%s ", col_on, -indent, $$1, col_off; \
|
|
n = split($$2, words, " "); \
|
|
line_length = ncol - indent; \
|
|
for (i = 1; i <= n; i++) { \
|
|
line_length -= length(words[i]) + 1; \
|
|
if (line_length <= 0) { \
|
|
line_length = ncol - indent - length(words[i]) - 1; \
|
|
printf "\n%*s ", -indent, " "; \
|
|
} \
|
|
printf "%s ", words[i]; \
|
|
} \
|
|
printf "\n"; \
|
|
}' \
|
|
| more $(shell test $(shell uname) = Darwin && echo '--no-init --raw-control-chars')
|