Merge pull request #42 from PrefectHQ/cruft-update

ran cruft update and manually edited in rejected changes
PrefectHQ · Nov 16, 2022 · 18e7c79 · 18e7c79
2 parents 490a4c8 + d05ba1a
commit 18e7c79
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 42 deletions.
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/PrefectHQ/prefect-collection-template",
-  "commit": "0f453a7cd6b0365e16c326a5e3350fe582b07086",
+  "commit": "61a4158a76515426f7a1736215565d486b379045",
   "checkout": null,
   "context": {
     "cookiecutter": {

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,32 +1,28 @@
-<!-- 
-Thanks for opening a pull request to prefect-airbyte 🎉!
+<!-- Thanks for contributing 🎉! Please ensure the title neatly summarizes the proposed changes. -->
 
-We've got a few requests to help us review contributions:
+<!-- Overview -->
 
-- Make sure that your title neatly summarizes the proposed changes.
-- Provide a short overview of the change and the value it adds.
-- Share an example to help us understand the change in user experience.
-- Run `pre-commit install && pre-commit run --all` for linting.
-
-Happy engineering!
--->
-
-<!-- Include an overview here -->
-
-<!-- Link to issue -->
-Closes #
+Closes
 
 ### Example
-<!-- 
-Share an example of the change in action.
-
-A code blurb is best. Changes to features should include an example that is executable by a new user.
+<!-- A code blurb is best. Changes to features should include an example that is executable by a new user. -->
+
+### Screenshots
+<!--
+Any relevant screenshots
+  - The updated docs page from `mkdocs serve`.
+  - Output from running the example.
+  - Service integration test results.
 -->
 
 ### Checklist
 <!-- These boxes may be checked after opening the pull request. -->
 
-- [ ] This pull request references any related issue by including "Closes #<ISSUE_NUMBER>"
-	- If no issue exists and your change is not a small fix, please [create an issue](https://github.com/PrefectHQ/prefect-airbyte/issues/new/choose) first.
-- [ ] This pull request includes tests or only affects documentation.
-- [ ] Summarized PR's changes in [CHANGELOG.md](https://github.com/PrefectHQ/prefect-airbyte/blob/main/CHANGELOG.md)
+- [ ] References any related issue by including "Closes #<Issue Number>" or "Closes <Issue URL>".
+  - If no issue exists and your change is not a small fix, please [create an issue](https://github.com/PrefectHQ/prefect-airbyte/issues/new/choose) first.
+- [ ] Includes tests or only affects documentation.
+- [ ] Passes `pre-commit` checks.
+  - Run `pre-commit install && pre-commit run --all` locally for formatting and linting.
+- [ ] Includes screenshots of documentation updates.
+  - Run `mkdocs serve` view documentation locally.
+- [ ] Summarizes PR's changes in [CHANGELOG.md](https://github.com/PrefectHQ/prefect-airbyte/blob/main/CHANGELOG.md)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -19,3 +19,11 @@ repos:
       - id: interrogate
         args: [-vv]
         pass_filenames: false
+  - repo: https://github.com/fsouza/autoflake8
+    rev: v0.3.2
+    hooks:
+      - id: autoflake8
+        language_version: python3
+        args: [
+          '--in-place',
+        ]
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,16 +35,16 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          rendering:
+          options:
             show_root_heading: True
             show_object_full_path: False
             show_category_heading: True
             show_bases: True
             show_signature: False
             heading_level: 1
-      watch:
-        - prefect_airbyte/
-        - README.md
+watch:
+  - prefect_airbyte/
+  - README.md
 nav:
     - Home: index.md
     - Client: client.md

diff --git a/prefect_airbyte/__init__.py b/prefect_airbyte/__init__.py
@@ -1,3 +1,5 @@
 from . import _version
 
+from prefect_airbyte.server import AirbyteServer  # noqa F401
+
 __version__ = _version.get_versions()["version"]
diff --git a/prefect_airbyte/exceptions.py b/prefect_airbyte/exceptions.py
@@ -6,52 +6,38 @@ class ConnectionNotFoundException(Exception):
     Raises when a requested Airbyte connection cannot be found.
     """
 
-    pass
-
 
 class AirbyteServerNotHealthyException(Exception):
     """
     Raises when a specified Airbyte instance returns an unhealthy response.
     """
 
-    pass
-
 
 class JobNotFoundException(Exception):
     """
     Raises when a requested Airbyte job cannot be found.
     """
 
-    pass
-
 
 class AirbyteSyncJobFailed(Exception):
     """
     Raises when a specified Airbyte Sync Job fails.
     """
 
-    pass
-
 
 class AirbyteExportConfigurationFailed(Exception):
     """
     Raises when an Airbyte configuration export fails.
     """
 
-    pass
-
 
 class AirbyteConnectionInactiveException(Exception):
     """
     Raises when a specified Airbyte connection is inactive.
     """
 
-    pass
-
 
 class AirbyeConnectionDeprecatedException(Exception):
     """
     Raises when a specified Airbyte connection is deprecated.
     """
-
-    pass
diff --git a/setup.py b/setup.py
@@ -27,6 +27,11 @@
     python_requires=">=3.7",
     install_requires=install_requires,
     extras_require={"dev": dev_requires},
+    entry_points={
+        "prefect.collections": [
+            "prefect_airbyte = prefect_airbyte",
+        ]
+    },
     classifiers=[
         "Natural Language :: English",
         "Intended Audience :: Developers",