Merge branch 'main' into 753-validate-taptarget-config-options

meltano · Aug 23, 2022 · ad77afa · ad77afa
2 parents 03ca8e0 + 9dac11c
commit ad77afa
Show file tree

Hide file tree

Showing 42 changed files with 373 additions and 174 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -15,7 +15,7 @@ body:
     attributes:
       label: Singer SDK Version
       description: Version of the library you are using
-      placeholder: "0.1.0"
+      placeholder: "0.8.0"
     validations:
       required: true
   - type: dropdown

diff --git a/.github/workflows/constraints.txt b/.github/workflows/constraints.txt
@@ -1,5 +1,5 @@
 pip==22.2.2
-poetry==1.1.14
+poetry==1.1.15
 virtualenv==20.16.3
 nox==2022.8.7
 nox-poetry==1.0.1
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -104,14 +104,10 @@ ReadtheDocs.org. When a push is detected by readthedocs.org, they automatically
 and republish the docs. ReadtheDocs is also version aware, so it retains prior and unreleased
 versions of the docs for us.
 
-To build the docs:
+To build the docs and live-reload them locally:
 
 ```bash
-# Build docs
-nox -rs docs
-
-# Open in the local browser:
-open build/index.html
+nox -rs docs-serve
 ```
 
 Sphinx will automatically generate class stubs, so be sure to `git add` them.

diff --git a/docs/_templates/class.rst b/docs/_templates/class.rst
@@ -5,3 +5,4 @@
 
 .. autoclass:: {{ name }}
     :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.BatchSink.rst b/docs/classes/singer_sdk.BatchSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: BatchSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.GraphQLStream.rst b/docs/classes/singer_sdk.GraphQLStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: GraphQLStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.InlineMapper.rst b/docs/classes/singer_sdk.InlineMapper.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: InlineMapper
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.RESTStream.rst b/docs/classes/singer_sdk.RESTStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RESTStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.RecordSink.rst b/docs/classes/singer_sdk.RecordSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: RecordSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLConnector.rst b/docs/classes/singer_sdk.SQLConnector.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLConnector
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLSink.rst b/docs/classes/singer_sdk.SQLSink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLSink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLStream.rst b/docs/classes/singer_sdk.SQLStream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLStream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTap.rst b/docs/classes/singer_sdk.SQLTap.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTap
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.SQLTarget.rst b/docs/classes/singer_sdk.SQLTarget.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: SQLTarget
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Sink.rst b/docs/classes/singer_sdk.Sink.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Sink
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Stream.rst b/docs/classes/singer_sdk.Stream.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Stream
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Tap.rst b/docs/classes/singer_sdk.Tap.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Tap
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.Target.rst b/docs/classes/singer_sdk.Target.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk
 
 .. autoclass:: Target
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst b/docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: APIKeyAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BasicAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst b/docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: BearerTokenAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst b/docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: OAuthJWTAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst b/docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: SimpleAuthenticator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst b/docs/classes/singer_sdk.exceptions.ConfigValidationError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: ConfigValidationError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.FatalAPIError.rst b/docs/classes/singer_sdk.exceptions.FatalAPIError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: FatalAPIError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst b/docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: InvalidStreamSortException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.MapExpressionError.rst b/docs/classes/singer_sdk.exceptions.MapExpressionError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: MapExpressionError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst b/docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: MaxRecordsLimitException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst b/docs/classes/singer_sdk.exceptions.RecordsWitoutSchemaException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: RecordsWitoutSchemaException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst b/docs/classes/singer_sdk.exceptions.RetriableAPIError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: RetriableAPIError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst b/docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: StreamMapConfigError
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst b/docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: TapStreamConnectionFailure
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst b/docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: TooManyRecordsException
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,9 +51,9 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-# Show typehints in the signature
-# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
+# Show typehints in the description, along with parameter descriptions
 autodoc_typehints = "signature"
+autodoc_class_signature = "separated"
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/implementation/at_least_once.md b/docs/implementation/at_least_once.md
@@ -42,7 +42,7 @@ For cases where the destination table _does not_ use primary keys, the most comm
 
 Within a staging table model file `stg_widgets.sql` in `dbt`:
 
-```jinja
+```sql+jinja
 SELECT
     widget_id,
     widget_name,

diff --git a/noxfile.py b/noxfile.py
@@ -126,3 +126,25 @@ def docs(session: Session) -> None:
         shutil.rmtree(build_dir)
 
     session.run("sphinx-build", *args)
+
+
+@session(name="docs-serve", python=main_python_version)
+def docs_serve(session: Session) -> None:
+    """Build the documentation."""
+    args = session.posargs or [
+        "--open-browser",
+        "--watch",
+        ".",
+        "--ignore",
+        "**/.nox/*",
+        "docs",
+        "build",
+        "-W",
+    ]
+    session.install(".[docs]")
+
+    build_dir = Path("build")
+    if build_dir.exists():
+        shutil.rmtree(build_dir)
+
+    session.run("sphinx-autobuild", *args)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@

		.. autoclass:: {{ name }}
		:members:
		:special-members: __init__