add Makefile

Author: NiklasTiede

.gitignore

@@ -1,5 +1,5 @@
 
-ideas.txt
+todo.txt
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

Makefile

@@ -0,0 +1,71 @@
+
+# ------------- Run with Uvicorn ------------------------------
+
+.PHONY: run
+
+run: ## run App on uvicorn server
+	uvicorn app.main:app --host 127.0.0.1 --port 1313 --reload
+
+
+
+# ------------- Test/Lint  ------------------------------------
+
+.PHONY: pre-commit pre-commit-update lint test
+
+pre-commit:
+	pre-commit run --all-files
+
+pre-commit-update:
+	pre-commit autoupdate
+
+lint: ## check style with flake8
+	flake8 app tests
+
+test: ## run tests quickly with the default Python
+	pytest -v
+
+
+
+# ------------- Clean Test/Lint Artifacts  ---------------------
+
+.PHONY: clean clean-pyc clean-test
+
+clean: clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .mypy_cache
+	rm -fr .pytest_cache
+
+
+
+# ------------  Docker  -----------------------------------
+
+.PHONY: docker-build docker-run docker-clean
+
+DOCKER_IMAGE = github-trending-api
+
+docker-build: ## build docker image from Dockerfile
+	docker build -t $(DOCKER_IMAGE) .
+
+docker-run: ## run API docker container
+	docker run -p 5000:5000 $(DOCKER_IMAGE)
+
+docker-clean: ## remove docker image
+	docker rmi -f $(DOCKER_IMAGE)
+
+
+
+# ------------  Help  --------------------------------------
+
+.PHONY: help
+
+help: ## This help.
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help

requirements-dev.txt

@@ -1,4 +1,5 @@
 # pre-commit, pytest, flake8, mypy, isort, black
+# python 3.9
 
 appdirs==1.4.4
 astroid==2.5.2

requirements-prod.txt

@@ -1,4 +1,5 @@
 # beautifulsoup4, fastapi, lxml, uvicorn, aiohttp
+# python 3.9
 
 aiohttp==3.7.4
 beautifulsoup4==4.9.3