Makefile

SHELL := /bin/bash

.SILENT:

.PHONY: help
.DEFAULT_GOAL := help
help:  ## Prints all the targets in all the Makefiles
	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: list
list:  ## List all make targets
	@${MAKE} -pRrn : -f $(MAKEFILE_LIST) 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | sort

##########################
### Env Common Targets ###
##########################

.PHONY: env_create
env_create:  ## Create the env; must be execute like so: $(make env_create)
	python3 -m venv venv

.PHONY: env_source
env_source:  ## Source the env; must be execute like so: $(make env_source)
	@echo 'source venv/bin/activate'

.PHONY: check-env
check-env: ## Checks if the virtual environment is activated
ifndef VIRTUAL_ENV
	$(error 'Virtualenv is not activated, please activate the Python virtual environment by running "$$(make env_source)".')
endif

###############################
### Script Specific Targets ###
###############################

# The default data we index is Vitalik's articles
DATADIR ?= data/vitalik_articles
INDEX_NAME ?= vitalik-index

## TODO: Parameterize
.PHONY: prepare_db
prepare_db: check-env ## Prepare the vectorized db
	python3 prepare_db.py $(DATADIR) $(INDEX_NAME)

## TODO: Parameterize
.PHONY: query_db
query_db:  check-env ## Query the vectorized db
	python3 query_db.py

.PHONY: streamlit_app
streamlit_app: check-env  ## Run the streamlit app
	streamlit run streamlit_app.py

####################
### Data Targets ###
####################

.PHONY: download_vitalik_articles
download_vitalik_articles: check-env ## Download vitalik's articles
	python3 data_helpers/vitalik_to_pdf.py

# https://github.com/JustAnotherArchivist/snscrape
.PHONY: download_twitter_user_tweets ## Download twitter user tweets (user=)
download_twitter_user_tweets: check-env
	snscrape --jsonl --max-results 10000 twitter-user $(user) > data/$(user).json

##########################
### Pip Common Targets ###
##########################

.PHONY: pip_freeze
pip_freeze: check-env ## Freeze the pip requirements
	pip freeze > requirements.txt

.PHONY: pip_install
pip_install: check-env ## Install the pip requirements
	pip install -r requirements.txt

#############################
### Python Common Targets ###
#############################

.PHONY: py_format
py_format: check-env  ## Format the python code
	black .
	isort .