feat: Cookiecutter target tox ini (#1438)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Edgar R. M <[email protected]>

Author: 3 people

cookiecutter/target-template/{{cookiecutter.target_id}}/tox.ini

@@ -0,0 +1,52 @@
+# This file can be used to customize tox tests as well as other test frameworks like flake8 and mypy
+
+[tox]
+envlist = py38
+; envlist = py37, py38, py39
+isolated_build = true
+
+[testenv]
+allowlist_externals = poetry
+
+commands =
+    poetry install -v
+    poetry run pytest
+    poetry run black --check {{cookiecutter.library_name}}/
+    poetry run flake8 {{cookiecutter.library_name}}
+    poetry run mypy {{cookiecutter.library_name}} --exclude='{{cookiecutter.library_name}}/tests'
+
+[testenv:pytest]
+# Run the python tests.
+# To execute, run `tox -e pytest`
+envlist = py37, py38, py39
+commands =
+    poetry install -v
+    poetry run pytest
+
+[testenv:format]
+# Attempt to auto-resolve lint errors before they are raised.
+# To execute, run `tox -e format`
+commands =
+    poetry install -v
+    poetry run black {{cookiecutter.library_name}}/
+    poetry run isort {{cookiecutter.library_name}}
+
+[testenv:lint]
+# Raise an error if lint and style standards are not met.
+# To execute, run `tox -e lint`
+commands =
+    poetry install -v
+    poetry run black --check --diff {{cookiecutter.library_name}}/
+    poetry run isort --check {{cookiecutter.library_name}}
+    poetry run flake8 {{cookiecutter.library_name}}
+    # refer to mypy.ini for specific settings
+    poetry run mypy {{cookiecutter.library_name}} --exclude='{{cookiecutter.library_name}}/tests'
+
+[flake8]
+docstring-convention = google
+ignore = W503
+max-line-length = 88
+max-complexity = 10
+
+[pydocstyle]
+ignore = D105,D203,D213

cookiecutter/target-template/{{cookiecutter.target_id}}/{{cookiecutter.library_name}}/sinks.py

@@ -47,7 +47,12 @@ class {{ cookiecutter.destination_name }}Sink({{ sinkclass }}):
 
     {% if sinkclass == "RecordSink" -%}
     def process_record(self, record: dict, context: dict) -> None:
-        """Process the record."""
+        """Process the record.
+
+        Args:
+            record: Individual record in the stream.
+            context: Stream partition or context dictionary.
+        """
         # Sample:
         # ------
         # client.write(record)
@@ -61,6 +66,9 @@ def start_batch(self, context: dict) -> None:
 
         Developers may optionally add additional markers to the `context` dict,
         which is unique to this batch.
+
+        Args:
+            context: Stream partition or context dictionary.
         """
         # Sample:
         # ------
@@ -72,14 +80,22 @@ def process_record(self, record: dict, context: dict) -> None:
 
         Developers may optionally read or write additional markers within the
         passed `context` dict from the current batch.
+
+        Args:
+            record: Individual record in the stream.
+            context: Stream partition or context dictionary.
         """
         # Sample:
         # ------
         # with open(context["file_path"], "a") as csvfile:
         #     csvfile.write(record)
 
     def process_batch(self, context: dict) -> None:
-        """Write out any prepped records and return once fully written."""
+        """Write out any prepped records and return once fully written.
+
+        Args:
+            context: Stream partition or context dictionary.
+        """
         # Sample:
         # ------
         # client.upload(context["file_path"])  # Upload file