add deployment files

Author: tarekbadrsh

Dockerfile

@@ -0,0 +1,24 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.8
+
+# Setup environment
+RUN apt-get update && apt-get install -y \
+    python3-distutils \
+    build-essential
+
+# Copy requirements
+COPY ./requirements ./requirements
+
+# Installing requirements
+RUN pip install -r ./requirements
+
+# Copy needed files (see .dockerignore for what will be included)
+COPY . /cdevents-client
+
+WORKDIR /cdevents-client
+
+# Build
+RUN /bin/bash -c "make package-install"
+
+WORKDIR /cdevents-client

Makefile

@@ -0,0 +1,75 @@
+include header.mk
+
+PACKAGES = template core web cli
+export ABS_ROOT_PATH=$(shell pwd)
+
+.PHONY: packages $(PACKAGES)
+
+packages: $(PACKAGES)
+
+$(PACKAGES):
+		$(MAKE) -C $@
+
+# the sets of directories to do various things in
+INITPACKAGES = $(PACKAGES:%=init-%)
+INSTALLPACKAGES = $(PACKAGES:%=package-install-%)
+CLEANPACKAGES = $(PACKAGES:%=clean-%)
+TESTPACKAGES = $(PACKAGES:%=test-%)
+LINTPACKAGES = $(PACKAGES:%=lint-%)
+FORMATPACKAGES = $(PACKAGES:%=format-%)
+BUMPVERSIONPACKAGES = $(PACKAGES:%=bumpversion-%)
+
+help: ## Prints this help text
+	@python -c "$$PRINT_HELP_PYSCRIPT" < Makefile
+
+init: $(INITPACKAGES) ## Installs all packages in editable mode including dev dependencies
+$(INITPACKAGES):
+	$(MAKE) -C $(@:init-%=%) init
+
+package-install: $(INSTALLPACKAGES) ## Installs all packages without dev dependencies
+$(INSTALLPACKAGES):
+	$(MAKE) -C $(@:package-install-%=%) package-install
+
+test: $(TESTPACKAGES) ## Run tests on all packages
+$(TESTPACKAGES):
+	$(MAKE) -C $(@:test-%=%) test
+
+clean: $(CLEANPACKAGES) ## Remove all build, test, coverage and Python artifacts
+$(CLEANPACKAGES):
+	$(MAKE) -C $(@:clean-%=%) clean
+
+bumpversion: ${BUMPVERSIONPACKAGES} ## Bumps the (default: patch) version of all release packages. To bump minor or major, add bump=minor or bump=major to the make call.
+$(BUMPVERSIONPACKAGES):
+	$(MAKE) -C $(@:bumpversion-%=%) bumpversion
+
+lint: $(LINTPACKAGES)
+$(LINTPACKAGES):
+	$(MAKE) -C $(@:lint-%=%) lint
+
+format: $(FORMATPACKAGES)
+$(FORMATPACKAGES):
+	$(MAKE) -C $(@:format-%=%) format
+
+install: ## Installs dependencies from requirements.txt
+	pip install -r ./requirements
+	pre-commit install
+
+internal-install: ## Installs VCC-internal dependencies from vcc-requirements.txt
+	pip install --extra-index-url https://TODO -r vccinternal-requirements.txt
+
+check: ## Runs pre-commit hooks on all files
+	pre-commit run --all-files
+
+docker-build: ## Build and package Docker container
+	docker build -t cdevents-client -f Dockerfile .
+
+docker-shell: ## Opens a shell
+	docker run --add-host=host.docker.internal:host-gateway --volume /"$(shell pwd)"/output/:/root/cdevents-client/ -it cdevents-client bash
+
+.PHONY: packages $(PACKAGES)
+.PHONY: packages $(INITPACKAGES)
+.PHONY: packages $(INSTALLPACKAGES)
+.PHONY: packages $(TESTPACKAGES)
+.PHONY: packages $(CLEANPACKAGES)
+.PHONY: packages $(BUMPVERSIONPACKAGES)
+.PHONY: init test clean bumpversion install internal-install check docker-build docker-shell

header.mk

@@ -0,0 +1,27 @@
+.PHONY: clean clean-test clean-pyc clean-build help
+.DEFAULT_GOAL := help
+
+define BROWSER_PYSCRIPT
+import os, webbrowser, sys
+
+try:
+	from urllib import pathname2url
+except:
+	from urllib.request import pathname2url
+
+webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
+endef
+export BROWSER_PYSCRIPT
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+BROWSER := python -c "$$BROWSER_PYSCRIPT"

targets.mk

@@ -0,0 +1,69 @@
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+init: clean ## install the package in editable mode including dev dependencies
+	pip install -e .[dev]
+	pre-commit install
+
+package-install: ## install the package without dev dependencies
+	pip install .
+
+test: ## run tests quickly with the default Python
+	python -m pytest -m unit
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+format: ## format all Python code using black
+	python -m black --line-length=100 .
+
+.ONESHELL:
+lint: ## run pylint
+	python -m pylint $(SRC) --rcfile=$(ABS_ROOT_PATH)/.pylintrc
+	exit_code=$$?
+	python -m pylint \
+		--disable duplicate-code \
+		--disable missing-module-docstring \
+		--disable missing-function-docstring \
+		tests --rcfile=$(ABS_ROOT_PATH)/.pylintrc
+	exit_code=`expr $${exit_code} + $$?`
+	if [ "$${exit_code}" != 0 ]; then
+		exit "$${exit_code}"
+	fi
+
+clean: clean-build clean-pyc clean-test clean-mypy ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	# N.B. line below removes editable intallation of package in venv
+	# find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+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 -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+clean-mypy: ## remove MyPy cache files
+	rm -fr .mypy_cache/
+
+bump = patch
+bumpversion: ## Bumps the (default: patch) version of this package. To bump minor or major, add bump=minor or bump=major to the make call.
+	bumpversion --allow-dirty $(bump)
+	- pre-commit run trailing-whitespace --file setup.cfg
+	- pre-commit run remove-tabs --file setup.cfg
+
+
+.ONESHELL:
+pre-commit:
+	pre-commit run --all-files