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

airbyte_source_kyriba-0.1.4/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: airbyte-source-kyriba
+Version: 0.1.4
+Summary: Source implementation for Kyriba.
+Home-page: https://airbyte.com
+License: MIT
+Author: Airbyte
+Author-email: contact@airbyte.io
+Requires-Python: >=3.9,<3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: airbyte-cdk (==0.80.0)
+Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/kyriba
+Project-URL: Repository, https://github.com/airbytehq/airbyte
+Description-Content-Type: text/markdown
+
+# Kyriba source connector
+
+This is the repository for the Kyriba source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/kyriba).
+
+## Local development
+
+### Prerequisites
+
+- Python (~=3.9)
+- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
+
+### Installing the connector
+
+From this connector directory, run:
+
+```bash
+poetry install --with dev
+```
+
+### Create credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/kyriba)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_kyriba/spec.yaml` file.
+Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
+See `sample_files/sample_config.json` for a sample config file.
+
+### Locally running the connector
+
+```
+poetry run source-kyriba spec
+poetry run source-kyriba check --config secrets/config.json
+poetry run source-kyriba discover --config secrets/config.json
+poetry run source-kyriba read --config secrets/config.json --catalog sample_files/configured_catalog.json
+```
+
+### Running unit tests
+
+To run unit tests locally, from the connector directory run:
+
+```
+poetry run pytest unit_tests
+```
+
+### Building the docker image
+
+1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
+2. Run the following command to build the docker image:
+
+```bash
+airbyte-ci connectors --name=source-kyriba build
+```
+
+An image will be available on your host with the tag `airbyte/source-kyriba:dev`.
+
+### Running as a docker container
+
+Then run any of the connector commands as follows:
+
+```
+docker run --rm airbyte/source-kyriba:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-kyriba:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+
+### Running our CI test suite
+
+You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+
+```bash
+airbyte-ci connectors --name=source-kyriba test
+```
+
+### Customizing acceptance Tests
+
+Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
+If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
+
+### Dependency Management
+
+All of your dependencies should be managed via Poetry.
+To add a new dependency, run:
+
+```bash
+poetry add <package-name>
+```
+
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
+
+## Publishing a new version of the connector
+
+You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+
+1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-kyriba test`
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
+   - bump the `dockerImageTag` value in in `metadata.yaml`
+   - bump the `version` value in `pyproject.toml`
+3. Make sure the `metadata.yaml` content is up to date.
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/kyriba.md`).
+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.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
+

airbyte_source_kyriba-0.1.4/README.md

@@ -0,0 +1,104 @@
+# Kyriba source connector
+
+This is the repository for the Kyriba source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/kyriba).
+
+## Local development
+
+### Prerequisites
+
+- Python (~=3.9)
+- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
+
+### Installing the connector
+
+From this connector directory, run:
+
+```bash
+poetry install --with dev
+```
+
+### Create credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/kyriba)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_kyriba/spec.yaml` file.
+Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
+See `sample_files/sample_config.json` for a sample config file.
+
+### Locally running the connector
+
+```
+poetry run source-kyriba spec
+poetry run source-kyriba check --config secrets/config.json
+poetry run source-kyriba discover --config secrets/config.json
+poetry run source-kyriba read --config secrets/config.json --catalog sample_files/configured_catalog.json
+```
+
+### Running unit tests
+
+To run unit tests locally, from the connector directory run:
+
+```
+poetry run pytest unit_tests
+```
+
+### Building the docker image
+
+1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
+2. Run the following command to build the docker image:
+
+```bash
+airbyte-ci connectors --name=source-kyriba build
+```
+
+An image will be available on your host with the tag `airbyte/source-kyriba:dev`.
+
+### Running as a docker container
+
+Then run any of the connector commands as follows:
+
+```
+docker run --rm airbyte/source-kyriba:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-kyriba:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+
+### Running our CI test suite
+
+You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
+
+```bash
+airbyte-ci connectors --name=source-kyriba test
+```
+
+### Customizing acceptance Tests
+
+Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
+If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
+
+### Dependency Management
+
+All of your dependencies should be managed via Poetry.
+To add a new dependency, run:
+
+```bash
+poetry add <package-name>
+```
+
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
+
+## Publishing a new version of the connector
+
+You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+
+1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-kyriba test`
+2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
+   - bump the `dockerImageTag` value in in `metadata.yaml`
+   - bump the `version` value in `pyproject.toml`
+3. Make sure the `metadata.yaml` content is up to date.
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/kyriba.md`).
+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.
+8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

airbyte_source_kyriba-0.1.4/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = [
+    "poetry-core>=1.0.0",
+]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+version = "0.1.4"
+name = "airbyte-source-kyriba"
+description = "Source implementation for Kyriba."
+authors = [
+    "Airbyte <contact@airbyte.io>",
+]
+license = "MIT"
+readme = "README.md"
+documentation = "https://docs.airbyte.com/integrations/sources/kyriba"
+homepage = "https://airbyte.com"
+repository = "https://github.com/airbytehq/airbyte"
+packages = [
+    { include = "source_kyriba" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.9,<3.12"
+airbyte-cdk = "0.80.0"
+
+[tool.poetry.scripts]
+source-kyriba = "source_kyriba.run:run"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^6.1"
+requests-mock = "^1.9.3"
+pytest-mock = "^3.6.1"

{airbyte-source-kyriba-0.1.1 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/accounts.json

@@ -5,265 +5,341 @@
   "$schema": "http://json-schema.org/schema#",
   "properties": {
     "accountCategory1": {
+      "description": "Represents account category 1 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the first account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the first account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory2": {
+      "description": "Represents account category 2 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the second account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the second account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory3": {
+      "description": "Represents account category 3 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the third account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the third account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory4": {
+      "description": "Represents account category 4 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the fourth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the fourth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory5": {
+      "description": "Represents account category 5 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the fifth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the fifth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory6": {
+      "description": "Represents account category 6 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the sixth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the sixth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory7": {
+      "description": "Represents account category 7 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the seventh account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the seventh account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory8": {
+      "description": "Represents account category 8 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the eighth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the eighth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory9": {
+      "description": "Represents account category 9 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the ninth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the ninth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountCategory10": {
+      "description": "Represents account category 10 data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the tenth account category",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the tenth account category",
           "type": ["null", "string"]
         }
       }
     },
     "accountAvailableForPayments": {
+      "description": "Indicates if the account is available for payments",
       "type": ["boolean", "null"]
     },
     "accountType": {
+      "description": "Type of the account",
       "type": ["string", "null"]
     },
     "activeStatus": {
+      "description": "Status indicating if the account is active",
       "type": ["string", "null"]
     },
     "attachments": {
+      "description": "Attachments associated with the account",
       "type": ["boolean", "null"]
     },
     "banCode": {
+      "description": "Bank account number (BAN) code",
       "type": ["string", "null"]
     },
     "bank": {
+      "description": "Represents bank data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the bank associated with the account",
           "type": ["string", "null"]
         },
         "uuid": {
+          "description": "UUID for the bank associated with the account",
           "type": ["string", "null"]
         }
       }
     },
     "branch": {
+      "description": "Represents branch data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Branch code associated with the account",
           "type": ["string", "null"]
         },
         "uuid": {
+          "description": "UUID for the branch associated with the account",
           "type": ["string", "null"]
         }
       }
     },
     "branchDescription": {
+      "description": "Description of the branch associated with the account",
       "type": ["null", "string"]
     },
     "calendar": {
+      "description": "Represents calendar data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the calendar linked to the account",
           "type": ["string", "null"]
         },
         "uuid": {
+          "description": "UUID for the calendar linked to the account",
           "type": ["string", "null"]
         }
       }
     },
     "closedAccount": {
+      "description": "Indicates if the account is closed",
       "type": ["boolean", "null"]
     },
     "closingDate": {
+      "description": "Date when the account was closed",
       "type": ["null", "string"]
     },
     "code": {
+      "description": "Account code",
       "type": ["string", "null"]
     },
     "company": {
+      "description": "Represents company data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the company associated with the account",
           "type": ["string", "null"]
         },
         "uuid": {
+          "description": "UUID for the company associated with the account",
           "type": ["string", "null"]
         }
       }
     },
     "countryCode": {
+      "description": "Country code of the account",
       "type": ["string", "null"]
     },
     "creationDate": {
+      "description": "Date when the account was created",
       "type": ["string", "null"]
     },
     "currency": {
+      "description": "Represents currency data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Currency code of the account",
           "type": ["string", "null"]
         },
         "uuid": {
+          "description": "UUID for the currency of the account",
           "type": ["string", "null"]
         }
       }
     },
     "defaultGroup": {
+      "description": "Represents default group data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "Code for the default group of the account",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the default group of the account",
           "type": ["null", "string"]
         }
       }
     },
     "description": {
+      "description": "Brief description of the account",
       "type": ["null", "string"]
     },
     "description2": {
+      "description": "Additional description field for the account",
       "type": ["null", "string"]
     },
     "documents": {
+      "description": "Documents associated with the account",
       "type": ["boolean", "null"]
     },
     "glAccount": {
+      "description": "Represents general ledger account data",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "General ledger (GL) account code",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID for the GL account linked to the account",
           "type": ["null", "string"]
         }
       }
     },
     "ibanCode": {
+      "description": "International Bank Account Number (IBAN) code",
       "type": ["null", "string"]
     },
     "internalAccountCode": {
+      "description": "Internal code for the account",
       "type": ["null", "string"]
     },
     "marker1": {
+      "description": "Custom marker 1 for the account",
       "type": ["boolean", "null"]
     },
     "marker2": {
+      "description": "Custom marker 2 for the account",
       "type": ["boolean", "null"]
     },
     "marker3": {
+      "description": "Custom marker 3 for the account",
       "type": ["boolean", "null"]
     },
     "signatoryUsers": {
+      "description": "Users authorized as signatories for the account",
       "type": ["integer", "null"]
     },
     "statementIdentifier": {
+      "description": "Identifier for the account statement",
       "type": ["null", "string"]
     },
     "status": {
+      "description": "Status of the account",
       "type": ["string", "null"]
     },
     "updateDate": {
+      "description": "Date when the account was last updated",
       "type": ["null", "string"]
     },
     "uuid": {
+      "description": "Unique identifier for the account",
       "type": ["string", "null"]
     },
     "zbaIdentifier": {
+      "description": "Zero balance account (ZBA) identifier",
       "type": ["null", "string"]
     }
   }

{airbyte-source-kyriba-0.1.1 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/bank_balances_eod.json

@@ -2,32 +2,41 @@
   "type": "object",
   "properties": {
     "account": {
+      "description": "Details of the account associated with the bank balance",
       "type": ["object", "null"],
       "properties": {
         "code": {
+          "description": "The unique code identifying the account",
           "type": ["string", "null"]
         },
         "statementIdentifier": {
+          "description": "Identifier for the statement associated with the account",
           "type": ["null", "string"]
         },
         "uuid": {
+          "description": "UUID (Universally Unique Identifier) of the account",
           "type": ["string", "null"]
         }
       }
     },
     "bankBalance": {
+      "description": "The end-of-day bank balance for the account",
       "type": ["object", "null"],
       "properties": {
         "amount": {
+          "description": "The balance amount of the account",
           "type": ["number", "null"]
         },
         "balanceDate": {
+          "description": "The date when the balance was recorded",
           "type": ["string", "null"]
         },
         "currencyCode": {
+          "description": "The currency code of the balance amount",
           "type": ["string", "null"]
         },
         "lastKnownBalanceDate": {
+          "description": "The date of the last known balance for the account",
           "type": ["null", "string"]
         }
       }