Merge pull request #9 from fyndata/feature/misc-config-test

Misc fixes and improvements to config and test setup

Author: glarrain

.circleci/config.yml

@@ -11,9 +11,9 @@
 #
 version: 2
 jobs:
-  build:
+  test-py37:
     docker:
-      - image: python:3.7.1
+      - image: python:3.7.2
 
     working_directory: ~/repo
 
@@ -28,19 +28,52 @@ jobs:
             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
+            tox -e py37
+            codecov
             make test-coverage-report-console
             make test-coverage-report-html
-            make dist
 
       - store_artifacts:
           path: test-reports
           destination: test-reports
+
+  dist:
+    docker:
+      - image: python:3.7.2
+
+    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/release.txt
+
+      - run:
+          name: make dist
+          command: |
+            . venv/bin/activate
+            make dist
+
+      - store_artifacts:
+          path: dist
+          destination: dist
+
+workflows:
+  version: 2
+  ci:
+    jobs:
+      - test-py37
+      - dist

.coveragerc

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Fyndata
+Copyright (c) 2019, Fyndata (Fynpal SpA)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,8 +1,4 @@
 include LICENSE
 include README.md
-
-recursive-include tests *
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-
-recursive-include docs *.md
+recursive-include fd_gcp *py
+include fd_gcp/py.typed

MANIFEST.in

@@ -4,25 +4,10 @@ SHELL = /usr/bin/env bash
 .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
-
+.PHONY: dist upload-release
 
 help:
-	@echo "Read README.md"
-	@echo ""
-	@echo "Makefile tasks:"
-	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+	@grep '^[a-zA-Z]' $(MAKEFILE_LIST) | sort | awk -F ':.*?## ' 'NF==2 {printf "\033[36m  %-25s\033[0m %s\n", $$1, $$2}'
 
 clean: clean-build clean-pyc clean-test ## remove all build, test, lint, coverage and Python artifacts
 
@@ -51,25 +36,26 @@ 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
+test: ## run tests quickly with the default Python
 	python setup.py test
 
 test-all: ## run tests on every Python version with tox
-	@echo "TODO: configure tox"
+	tox
 
 test-coverage: ## run tests and record test coverage
-	coverage run setup.py test
+	coverage run --rcfile=setup.cfg setup.py test
 
 test-coverage-report-console: ## print test coverage summary
-	coverage report -m
+	coverage report --rcfile=setup.cfg -m
 
 test-coverage-report-html: ## generate test coverage HTML report
-	coverage html
+	coverage html --rcfile=setup.cfg
 
 dist: clean ## builds source and wheel package
 	python setup.py sdist
 	python setup.py bdist_wheel
+	twine check dist/*
 	ls -l dist
 
-install: clean ## install the package to the active Python's site-packages
-	python setup.py install
+upload-release: ## upload dist packages
+	python -m twine upload 'dist/*'

Makefile

@@ -2,13 +2,17 @@
 -r base.txt
 
 # Required packages:
+codecov==2.0.15
 coverage==4.5.2
 flake8==3.7.6
 mypy==0.670
 #requests-mock==1.5.2
-#tox==3.2.1
+tox==3.7.0
 
 # Packages dependencies:
+#   - codecov:
+#       - coverage
+#       - requests
 #   - flake8:
 #       - mccabe
 #       - pycodestyle
@@ -17,14 +21,18 @@ mypy==0.670
 #       - mypy-extensions
 #       - typed-ast
 #   - tox:
+#       - filelock
 #       - pluggy
 #       - py
+#       - toml
 #       - virtualenv
+filelock==3.0.10
 mccabe==0.6.1
 mypy-extensions==0.4.1
-#pluggy==0.7.1
-#py==1.5.4
+pluggy==0.9.0
+py==1.8.0
 pycodestyle==2.5.0
 pyflakes==2.1.0
+toml==0.10.0
 typed-ast==1.3.1
-#virtualenv==16.0.0
+virtualenv==16.4.3

requirements/test.txt

@@ -1,6 +1,21 @@
 [bdist_wheel]
 universal = 0
 
+[coverage:run]
+source = fd_gcp/
+omit =
+    tests/*
+branch = True
+
+[coverage:report]
+exclude_lines =
+    pragma: no cover
+    if __name__ == .__main__.
+show_missing = True
+
+[coverage:html]
+directory = test-reports/coverage/html
+
 [mypy]
 python_version = 3.7
 platform = linux

setup.cfg

@@ -48,6 +48,7 @@ def get_version(*file_paths: Sequence[str]) -> str:
 #   - https://www.python.org/dev/peps/pep-0561/#packaging-type-information
 #   - https://github.com/python/typing/issues/84
 #   - https://github.com/python/mypy/issues/3930
+# warning: remember to replicate this in the manifest file for source distribution ('MANIFEST.in').
 _package_data = {
     'fd_gcp': [
         # Indicates that the "typing information" of the package should be distributed.
@@ -56,16 +57,18 @@ def get_version(*file_paths: Sequence[str]) -> str:
 }
 
 setup(
-    author="Fyndata",
+    author='Fyndata (Fynpal SpA)',
     author_email='no-reply@fyndata.com',
     classifiers=[
         'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3.7',
     ],
     description="Fyndata's Python library of Google Cloud Platform (GCP) utils.",
     # extras_require=extras_requirements,
     install_requires=requirements,
+    license="MIT",
     long_description=readme,
     long_description_content_type='text/markdown',
     include_package_data=True,

setup.py

@@ -1,8 +1,12 @@
 [tox]
-envlist = py37
+envlist =
+    py37
 
 [testenv]
 setenv =
-    PYTHONPATH = {toxinidir}
-
-commands = python setup.py test
+    PYTHONPATH = {toxinidir}:{toxinidir}/fd_gcp
+commands = coverage run --rcfile=setup.cfg setup.py test
+deps =
+    -r{toxinidir}/requirements/test.txt
+basepython =
+    py37: python3.7