airbyte-source-kyriba 0.1.0__tar.gz → 0.1.1__tar.gz

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: airbyte-source-kyriba
-Version: 0.1.0
+Version: 0.1.1
 Summary: Source implementation for Kyriba.
 Author: Airbyte
 Author-email: contact@airbyte.io
 Description-Content-Type: text/markdown
-Requires-Dist: airbyte-cdk~=0.1
+Requires-Dist: airbyte-cdk
 Provides-Extra: tests
 Requires-Dist: requests-mock~=1.9.3; extra == "tests"
 Requires-Dist: pytest~=6.1; extra == "tests"
@@ -56,18 +56,61 @@ python main.py read --config secrets/config.json --catalog integration_tests/con
 
 
 
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+
+
+The Airbyte way of building this connector is to use our `airbyte-ci` tool.
+You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
+Then running the following command will build your connector:
+
 ```bash
-airbyte-ci connectors --name=source-kyriba build
+airbyte-ci connectors --name source-kyriba build
 ```
+Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-kyriba:dev`.
+
+When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
+You can customize our build process by adding a `build_customization.py` module to your connector.
+This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
+It will be imported at runtime by our build process and the functions will be called if they exist.
+
+Here is an example of a `build_customization.py` module:
+```python
+from __future__ import annotations
 
-An image will be built with the tag `airbyte/source-kyriba:dev`.
+from typing import TYPE_CHECKING
 
-**Via `docker build`:**
+if TYPE_CHECKING:
+from dagger import Container
+
+
+async def pre_connector_install(base_image_container: Container) -> Container:
+return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
+
+async def post_connector_install(connector_container: Container) -> Container:
+return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
+```
+
+This connector is built using our dynamic built process in `airbyte-ci`.
+The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
+The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
+It does not rely on a Dockerfile.
+
+If you would like to patch our connector and build your own a simple approach would be to:
+
+1. Create your own Dockerfile based on the latest version of the connector image.
+```Dockerfile
+FROM airbyte/source-kyriba:latest
+
+COPY . ./airbyte/integration_code
+RUN pip install ./airbyte/integration_code
+
+```
+Please use this as an example. This is not optimized.
+
+2. Build your image:
 ```bash
 docker build -t airbyte/source-kyriba:dev .
+docker run airbyte/source-kyriba:dev spec
 ```
-
 Then run any of the connector commands as follows:
 ```
 docker run --rm airbyte/source-kyriba:dev spec

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/README.md

@@ -8,7 +8,7 @@ For information about how to use this connector within Airbyte, see [the documen
 ### Prerequisites
 **To iterate on this connector, make sure to complete this prerequisites section.**
 
-#### Minimum Python version required `= 3.7.0`
+#### Minimum Python version required `= 3.10.0`
 
 #### Build & Activate Virtual Environment and install dependencies
 From this connector directory, create a virtual environment:
@@ -50,19 +50,70 @@ python main.py read --config secrets/config.json --catalog integration_tests/con
 ### Locally running the connector docker image
 
 
-#### Build
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+
+
+#### Use `airbyte-ci` to build your connector
+The Airbyte way of building this connector is to use our `airbyte-ci` tool.
+You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
+Then running the following command will build your connector:
+
 ```bash
-airbyte-ci connectors --name=source-kyriba build
+airbyte-ci connectors --name source-kyriba build
+```
+Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-kyriba:dev`.
+
+##### Customizing our build process
+When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
+You can customize our build process by adding a `build_customization.py` module to your connector.
+This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
+It will be imported at runtime by our build process and the functions will be called if they exist.
+
+Here is an example of a `build_customization.py` module:
+```python
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    # Feel free to check the dagger documentation for more information on the Container object and its methods.
+    # https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
+    from dagger import Container
+
+
+async def pre_connector_install(base_image_container: Container) -> Container:
+    return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
+
+async def post_connector_install(connector_container: Container) -> Container:
+    return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
 ```
 
-An image will be built with the tag `airbyte/source-kyriba:dev`.
+#### Build your own connector image
+This connector is built using our dynamic built process in `airbyte-ci`.
+The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
+The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
+It does not rely on a Dockerfile.
+
+If you would like to patch our connector and build your own a simple approach would be to:
+
+1. Create your own Dockerfile based on the latest version of the connector image.
+```Dockerfile
+FROM airbyte/source-kyriba:latest
+
+COPY . ./airbyte/integration_code
+RUN pip install ./airbyte/integration_code
 
-**Via `docker build`:**
+# The entrypoint and default env vars are already set in the base image
+# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+```
+Please use this as an example. This is not optimized.
+
+2. Build your image:
 ```bash
 docker build -t airbyte/source-kyriba:dev .
+# Running the spec command against your patched connector
+docker run airbyte/source-kyriba:dev spec
 ```
-
 #### Run
 Then run any of the connector commands as follows:
 ```
@@ -97,4 +148,3 @@ You've checked out the repo, implemented a million dollar feature, and you're re
 5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
 6. Pat yourself on the back for being an awesome contributor.
 7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
-

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/airbyte_source_kyriba.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: airbyte-source-kyriba
-Version: 0.1.0
+Version: 0.1.1
 Summary: Source implementation for Kyriba.
 Author: Airbyte
 Author-email: contact@airbyte.io
 Description-Content-Type: text/markdown
-Requires-Dist: airbyte-cdk~=0.1
+Requires-Dist: airbyte-cdk
 Provides-Extra: tests
 Requires-Dist: requests-mock~=1.9.3; extra == "tests"
 Requires-Dist: pytest~=6.1; extra == "tests"
@@ -56,18 +56,61 @@ python main.py read --config secrets/config.json --catalog integration_tests/con
 
 
 
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+
+
+The Airbyte way of building this connector is to use our `airbyte-ci` tool.
+You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
+Then running the following command will build your connector:
+
 ```bash
-airbyte-ci connectors --name=source-kyriba build
+airbyte-ci connectors --name source-kyriba build
 ```
+Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-kyriba:dev`.
+
+When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
+You can customize our build process by adding a `build_customization.py` module to your connector.
+This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
+It will be imported at runtime by our build process and the functions will be called if they exist.
+
+Here is an example of a `build_customization.py` module:
+```python
+from __future__ import annotations
 
-An image will be built with the tag `airbyte/source-kyriba:dev`.
+from typing import TYPE_CHECKING
 
-**Via `docker build`:**
+if TYPE_CHECKING:
+from dagger import Container
+
+
+async def pre_connector_install(base_image_container: Container) -> Container:
+return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
+
+async def post_connector_install(connector_container: Container) -> Container:
+return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
+```
+
+This connector is built using our dynamic built process in `airbyte-ci`.
+The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
+The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
+It does not rely on a Dockerfile.
+
+If you would like to patch our connector and build your own a simple approach would be to:
+
+1. Create your own Dockerfile based on the latest version of the connector image.
+```Dockerfile
+FROM airbyte/source-kyriba:latest
+
+COPY . ./airbyte/integration_code
+RUN pip install ./airbyte/integration_code
+
+```
+Please use this as an example. This is not optimized.
+
+2. Build your image:
 ```bash
 docker build -t airbyte/source-kyriba:dev .
+docker run airbyte/source-kyriba:dev spec
 ```
-
 Then run any of the connector commands as follows:
 ```
 docker run --rm airbyte/source-kyriba:dev spec

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/airbyte_source_kyriba.egg-info/requires.txt

@@ -1,4 +1,4 @@
-airbyte-cdk~=0.1
+airbyte-cdk
 
 [tests]
 requests-mock~=1.9.3

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = airbyte-source-kyriba
-version = 0.1.0
+version = 0.1.1
 author = Airbyte
 author_email = contact@airbyte.io
 long_description = # Kyriba Source
@@ -48,18 +48,61 @@ long_description = # Kyriba Source
 	
 	
 	
-	**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
+	
+	
+	The Airbyte way of building this connector is to use our `airbyte-ci` tool.
+	You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
+	Then running the following command will build your connector:
+	
 	```bash
-	airbyte-ci connectors --name=source-kyriba build
+	airbyte-ci connectors --name source-kyriba build
 	```
+	Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-kyriba:dev`.
+	
+	When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
+	You can customize our build process by adding a `build_customization.py` module to your connector.
+	This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
+	It will be imported at runtime by our build process and the functions will be called if they exist.
+	
+	Here is an example of a `build_customization.py` module:
+	```python
+	from __future__ import annotations
 	
-	An image will be built with the tag `airbyte/source-kyriba:dev`.
+	from typing import TYPE_CHECKING
 	
-	**Via `docker build`:**
+	if TYPE_CHECKING:
+	from dagger import Container
+	
+	
+	async def pre_connector_install(base_image_container: Container) -> Container:
+	return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
+	
+	async def post_connector_install(connector_container: Container) -> Container:
+	return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
+	```
+	
+	This connector is built using our dynamic built process in `airbyte-ci`.
+	The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
+	The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
+	It does not rely on a Dockerfile.
+	
+	If you would like to patch our connector and build your own a simple approach would be to:
+	
+	1. Create your own Dockerfile based on the latest version of the connector image.
+	```Dockerfile
+	FROM airbyte/source-kyriba:latest
+	
+	COPY . ./airbyte/integration_code
+	RUN pip install ./airbyte/integration_code
+	
+	```
+	Please use this as an example. This is not optimized.
+	
+	2. Build your image:
 	```bash
 	docker build -t airbyte/source-kyriba:dev .
+	docker run airbyte/source-kyriba:dev spec
 	```
-	
 	Then run any of the connector commands as follows:
 	```
 	docker run --rm airbyte/source-kyriba:dev spec

{airbyte-source-kyriba-0.1.0 → airbyte-source-kyriba-0.1.1}/setup.py

@@ -6,7 +6,7 @@
 from setuptools import find_packages, setup
 
 MAIN_REQUIREMENTS = [
-    "airbyte-cdk~=0.1",
+    "airbyte-cdk",
 ]
 
 TEST_REQUIREMENTS = [

airbyte-source-kyriba-0.1.1/source_kyriba/schemas/accounts.json

@@ -0,0 +1,270 @@
+{
+  "type": ["object", "null"],
+  "title": "AccountSearchModel",
+  "description": "Account search",
+  "$schema": "http://json-schema.org/schema#",
+  "properties": {
+    "accountCategory1": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory2": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory3": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory4": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory5": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory6": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory7": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory8": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory9": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountCategory10": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "accountAvailableForPayments": {
+      "type": ["boolean", "null"]
+    },
+    "accountType": {
+      "type": ["string", "null"]
+    },
+    "activeStatus": {
+      "type": ["string", "null"]
+    },
+    "attachments": {
+      "type": ["boolean", "null"]
+    },
+    "banCode": {
+      "type": ["string", "null"]
+    },
+    "bank": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "branch": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "branchDescription": {
+      "type": ["null", "string"]
+    },
+    "calendar": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "closedAccount": {
+      "type": ["boolean", "null"]
+    },
+    "closingDate": {
+      "type": ["null", "string"]
+    },
+    "code": {
+      "type": ["string", "null"]
+    },
+    "company": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "countryCode": {
+      "type": ["string", "null"]
+    },
+    "creationDate": {
+      "type": ["string", "null"]
+    },
+    "currency": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "defaultGroup": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "description": {
+      "type": ["null", "string"]
+    },
+    "description2": {
+      "type": ["null", "string"]
+    },
+    "documents": {
+      "type": ["boolean", "null"]
+    },
+    "glAccount": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["null", "string"]
+        }
+      }
+    },
+    "ibanCode": {
+      "type": ["null", "string"]
+    },
+    "internalAccountCode": {
+      "type": ["null", "string"]
+    },
+    "marker1": {
+      "type": ["boolean", "null"]
+    },
+    "marker2": {
+      "type": ["boolean", "null"]
+    },
+    "marker3": {
+      "type": ["boolean", "null"]
+    },
+    "signatoryUsers": {
+      "type": ["integer", "null"]
+    },
+    "statementIdentifier": {
+      "type": ["null", "string"]
+    },
+    "status": {
+      "type": ["string", "null"]
+    },
+    "updateDate": {
+      "type": ["null", "string"]
+    },
+    "uuid": {
+      "type": ["string", "null"]
+    },
+    "zbaIdentifier": {
+      "type": ["null", "string"]
+    }
+  }
+}

airbyte-source-kyriba-0.1.1/source_kyriba/schemas/bank_balances_eod.json

@@ -0,0 +1,39 @@
+{
+  "type": "object",
+  "properties": {
+    "account": {
+      "type": ["object", "null"],
+      "properties": {
+        "code": {
+          "type": ["string", "null"]
+        },
+        "statementIdentifier": {
+          "type": ["null", "string"]
+        },
+        "uuid": {
+          "type": ["string", "null"]
+        }
+      }
+    },
+    "bankBalance": {
+      "type": ["object", "null"],
+      "properties": {
+        "amount": {
+          "type": ["number", "null"]
+        },
+        "balanceDate": {
+          "type": ["string", "null"]
+        },
+        "currencyCode": {
+          "type": ["string", "null"]
+        },
+        "lastKnownBalanceDate": {
+          "type": ["null", "string"]
+        }
+      }
+    }
+  },
+  "title": "BK-BankStatementBalanceModel",
+  "description": "Bank statement balance.",
+  "$schema": "http://json-schema.org/schema#"
+}