feat: Improvements as per first round of feedback.

Author: hydratim

Dockerfile

@@ -8,7 +8,7 @@ WORKDIR /app
 COPY pyproject.toml .
 COPY poetry.lock .
 RUN pip3 install --no-cache-dir poetry
-RUN poetry install
+RUN poetry install --no-dev --no-interaction --no-ansi
 
 # Copy the rest of the code
 COPY plugin plugin
@@ -17,7 +17,7 @@ COPY main.py .
 # (Optional) Expose any ports your app uses
 EXPOSE 7777
 
-ENTRYPOINT ["python3", "main.py"]
+ENTRYPOINT ["poetry", "run", "main"]
 
 # Specify the command to run when the container starts
 CMD ["serve", "--address", "[::]:7777", "--log-format", "json", "--log-level", "info"]

README.md

@@ -59,6 +59,20 @@ Adding these to the CloudQuery config spec can be done by editing the `Spec` `da
 ### Plugin
 Finally, you need to edit the `plugin.py` file to set the plugin name and version, and add the `Tables` to the `get_tables` function. 
 
+### Test run
+To test your plugin you can run it locally.
+
+To automatically manage your virtual environment and install the dependencies listed in the `pyproject.toml` you can use `poetry`.
+Poetry is an improved package & environment manager for Python that uses the standardised `pyproject.toml`, if you don't have it installed you can pull it with `pip install poetry`.
+
+To install the dependencies into a new virtual environment run `poetry install`.
+If you have additional dependencies you can add them with `poetry add {package_name}` which will add them to the `pyproject.toml` and install them into the virtual environment.
+
+Then to run the plugin `poetry run main serve`, which will launch the plugin manually as a GRPC service.
+
+With that running you can adjust the `TestConfig.yaml` to match your plugin and run `cloudquery sync`.
+This should result in the creation of a sqlite database `db.sqlite` where you can validate your tables are as expected.
+
 
 ## Links
 

TestConfig.yaml

@@ -0,0 +1,17 @@
+kind: source
+spec:
+  name: "comics"
+  registry: "grpc"
+  path: "localhost:7777"
+  tables: ['*']
+  destinations: ["sqlite"]
+  spec:
+    base_url: https://xkcd.com
+---
+kind: destination
+spec:
+  name: sqlite
+  path: cloudquery/sqlite
+  version: "v2.4.11"
+  spec:
+    connection_string: ./db.sqlite

poetry.lock

@@ -4,15 +4,18 @@ version = "0.1.0"
 description = ""
 authors = ["Plaintextnerds <[email protected]>"]
 readme = "README.md"
-packages = [{include = "example"}]
+packages = [{include = "plugin"}]
 
 [tool.poetry.dependencies]
 python = "^3.9,<3.13"
-cloudquery-plugin-sdk = "^0.1.5"
+cloudquery-plugin-sdk = "^0.1.6"
 pydantic = "^2.4"
 pyarrow = "^12.0"
 requests = "^2.31.0"
 
+[tool.poetry.scripts]
+main = "main:main"
+
 
 [build-system]
 requires = ["poetry-core"]