Merge pull request #1 from fyndata/feature/project-setup

Basic project setup

Author: glarrain

.circleci/config.yml

@@ -0,0 +1,46 @@
+# CircleCI 2.0 configuration file for this project.
+#
+# Notes:
+#   - Do not use CircleCI's brand of Docker images unless it is for a secondary environment.
+#   - We chose not to use dependencies caching because it is complicated to do it right and it is
+#     not worth the effort for a project so small.
+#
+# For more information check out:
+#   - https://circleci.com/docs/2.0/language-python/ for more details
+#   - https://circleci.com/docs/2.0/configuration-reference/
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: python:3.7.1
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install --upgrade pip
+            pip install --upgrade setuptools wheel
+            pip install -r requirements/test.txt
+#            pip install -r requirements/extras.txt
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            make lint
+            make test-coverage
+            make test-coverage-report-console
+            make test-coverage-report-html
+            make dist
+
+      - store_artifacts:
+          path: test-reports
+          destination: test-reports

.coveragerc

@@ -0,0 +1,14 @@
+[run]
+source =
+    fd_gcp/
+
+branch = True
+
+[report]
+exclude_lines =
+    pragma: no cover
+    if __name__ == .__main__.
+show_missing = True
+
+[html]
+directory = test-reports/coverage/html

MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.md

Makefile

@@ -0,0 +1,75 @@
+SHELL = /usr/bin/env bash
+
+.DEFAULT_GOAL := help
+.PHONY: help
+.PHONY: clean clean-build clean-pyc clean-test
+.PHONY: lint test test-all test-coverage test-coverage-report-console test-coverage-report-html
+.PHONY: dist install
+
+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
+
+
+help:
+	@echo "Read README.md"
+	@echo ""
+	@echo "Makefile tasks:"
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, lint, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -rf .eggs/
+	rm -rf build/
+	rm -rf dist/
+	find . -name '*.egg-info' -exec rm -rf {} +
+	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 -rf {} +
+
+clean-test: ## remove test, lint and coverage artifacts
+	rm -rf .cache/
+	rm -rf .tox/
+	rm -f .coverage
+	rm -rf htmlcov/
+	rm -rf test-reports/
+	rm -rf .mypy_cache/
+
+lint: ## run tools for code style analysis, static type check, etc
+	flake8 --config=setup.cfg  fd_gcp  tests
+	mypy --config-file setup.cfg  fd_gcp
+
+test: ## run tests
+	python setup.py test
+
+test-all: ## run tests on every Python version with tox
+	@echo "TODO: configure tox"
+
+test-coverage: ## run tests and record test coverage
+	coverage run setup.py test
+
+test-coverage-report-console: ## print test coverage summary
+	coverage report -m
+
+test-coverage-report-html: ## generate test coverage HTML report
+	coverage html
+
+dist: clean ## builds source and wheel package
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean ## install the package to the active Python's site-packages
+	python setup.py install

docs/.gitkeep

@@ -0,0 +1,3 @@
+# This file exists because many tools, services and platforms expect it to be
+# in the root directory of a Python project.
+-r requirements/release.txt

fd_gcp/__init__.py

@@ -0,0 +1,8 @@
+# requirements common to all "run modes"
+# note: it is mandatory to register all dependencies of the required packages.
+
+# Required packages:
+# None
+
+# Packages dependencies:
+# None

fd_gcp/py.typed

@@ -0,0 +1,27 @@
+# note: it is mandatory to register all dependencies of the required packages.
+# (pro tip: keep to the minimum the number of packages declared here)
+-r base.txt
+
+# Required packages:
+setuptools==40.6.3
+twine==1.12.1
+wheel==0.32.3
+
+# Packages dependencies:
+#   - twine:
+#       - pkginfo
+#       - readme-renderer
+#           - bleach
+#               - webencodings
+#           - docutils
+#           - Pygments
+#           - six
+#       - requests
+#       - requests-toolbelt
+#       - setuptools
+#       - tqdm
+pkginfo==1.5.0.1
+readme-renderer==24.0
+requests==2.21.0
+requests-toolbelt==0.8.0
+tqdm==4.29.1