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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/PKG-INFO +25 -11
  2. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/README.md +24 -11
  3. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/pyproject.toml +1 -1
  4. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/__init__.py +0 -0
  5. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/run.py +0 -0
  6. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/accounts.json +0 -0
  7. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/bank_balances_eod.json +0 -0
  8. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/bank_balances_intraday.json +0 -0
  9. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/cash_balances_eod.json +0 -0
  10. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/cash_balances_intraday.json +0 -0
  11. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/cash_flows.json +0 -0
  12. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/schemas/shared/_definitions.json +0 -0
  13. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/source.py +0 -0
  14. {airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/source_kyriba/spec.json +0 -0
{airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: airbyte-source-kyriba
3
- Version: 0.1.3
3
+ Version: 0.1.4
4
4
  Summary: Source implementation for Kyriba.
5
5
  Home-page: https://airbyte.com
6
6
  License: MIT
@@ -19,32 +19,33 @@ Description-Content-Type: text/markdown
19
19
 
20
20
  # Kyriba source connector
21
21
 
22
-
23
22
  This is the repository for the Kyriba source connector, written in Python.
24
23
  For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/kyriba).
25
24
 
26
25
  ## Local development
27
26
 
28
27
  ### Prerequisites
29
- * Python (~=3.9)
30
- * Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
31
28
 
29
+ - Python (~=3.9)
30
+ - Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
32
31
 
33
32
  ### Installing the connector
33
+
34
34
  From this connector directory, run:
35
+
35
36
  ```bash
36
37
  poetry install --with dev
37
38
  ```
38
39
 
39
-
40
40
  ### Create credentials
41
+
41
42
  **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/kyriba)
42
43
  to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_kyriba/spec.yaml` file.
43
44
  Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
44
45
  See `sample_files/sample_config.json` for a sample config file.
45
46
 
46
-
47
47
  ### Locally running the connector
48
+
48
49
  ```
49
50
  poetry run source-kyriba spec
50
51
  poetry run source-kyriba check --config secrets/config.json
@@ -53,23 +54,28 @@ poetry run source-kyriba read --config secrets/config.json --catalog sample_file
53
54
  ```
54
55
 
55
56
  ### Running unit tests
57
+
56
58
  To run unit tests locally, from the connector directory run:
59
+
57
60
  ```
58
61
  poetry run pytest unit_tests
59
62
  ```
60
63
 
61
64
  ### Building the docker image
65
+
62
66
  1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
63
67
  2. Run the following command to build the docker image:
68
+
64
69
  ```bash
65
70
  airbyte-ci connectors --name=source-kyriba build
66
71
  ```
67
72
 
68
73
  An image will be available on your host with the tag `airbyte/source-kyriba:dev`.
69
74
 
70
-
71
75
  ### Running as a docker container
76
+
72
77
  Then run any of the connector commands as follows:
78
+
73
79
  ```
74
80
  docker run --rm airbyte/source-kyriba:dev spec
75
81
  docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev check --config /secrets/config.json
@@ -78,18 +84,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
78
84
  ```
79
85
 
80
86
  ### Running our CI test suite
87
+
81
88
  You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
89
+
82
90
  ```bash
83
91
  airbyte-ci connectors --name=source-kyriba test
84
92
  ```
85
93
 
86
94
  ### Customizing acceptance Tests
95
+
87
96
  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.
88
97
  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.
89
98
 
90
99
  ### Dependency Management
91
- All of your dependencies should be managed via Poetry.
100
+
101
+ All of your dependencies should be managed via Poetry.
92
102
  To add a new dependency, run:
103
+
93
104
  ```bash
94
105
  poetry add <package-name>
95
106
  ```
@@ -97,14 +108,17 @@ poetry add <package-name>
97
108
  Please commit the changes to `pyproject.toml` and `poetry.lock` files.
98
109
 
99
110
  ## Publishing a new version of the connector
111
+
100
112
  You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
113
+
101
114
  1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-kyriba test`
102
- 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)):
103
- - bump the `dockerImageTag` value in in `metadata.yaml`
104
- - bump the `version` value in `pyproject.toml`
115
+ 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)):
116
+ - bump the `dockerImageTag` value in in `metadata.yaml`
117
+ - bump the `version` value in `pyproject.toml`
105
118
  3. Make sure the `metadata.yaml` content is up to date.
106
119
  4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/kyriba.md`).
107
120
  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).
108
121
  6. Pat yourself on the back for being an awesome contributor.
109
122
  7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
110
123
  8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
124
+
{airbyte_source_kyriba-0.1.3 → airbyte_source_kyriba-0.1.4}/README.md RENAMED
@@ -1,31 +1,32 @@
1
1
  # Kyriba source connector
2
2
 
3
-
4
3
  This is the repository for the Kyriba source connector, written in Python.
5
4
  For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/kyriba).
6
5
 
7
6
  ## Local development
8
7
 
9
8
  ### Prerequisites
10
- * Python (~=3.9)
11
- * Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
12
9
 
10
+ - Python (~=3.9)
11
+ - Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
13
12
 
14
13
  ### Installing the connector
14
+
15
15
  From this connector directory, run:
16
+
16
17
  ```bash
17
18
  poetry install --with dev
18
19
  ```
19
20
 
20
-
21
21
  ### Create credentials
22
+
22
23
  **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/kyriba)
23
24
  to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_kyriba/spec.yaml` file.
24
25
  Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
25
26
  See `sample_files/sample_config.json` for a sample config file.
26
27
 
27
-
28
28
  ### Locally running the connector
29
+
29
30
  ```
30
31
  poetry run source-kyriba spec
31
32
  poetry run source-kyriba check --config secrets/config.json
@@ -34,23 +35,28 @@ poetry run source-kyriba read --config secrets/config.json --catalog sample_file
34
35
  ```
35
36
 
36
37
  ### Running unit tests
38
+
37
39
  To run unit tests locally, from the connector directory run:
40
+
38
41
  ```
39
42
  poetry run pytest unit_tests
40
43
  ```
41
44
 
42
45
  ### Building the docker image
46
+
43
47
  1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
44
48
  2. Run the following command to build the docker image:
49
+
45
50
  ```bash
46
51
  airbyte-ci connectors --name=source-kyriba build
47
52
  ```
48
53
 
49
54
  An image will be available on your host with the tag `airbyte/source-kyriba:dev`.
50
55
 
51
-
52
56
  ### Running as a docker container
57
+
53
58
  Then run any of the connector commands as follows:
59
+
54
60
  ```
55
61
  docker run --rm airbyte/source-kyriba:dev spec
56
62
  docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kyriba:dev check --config /secrets/config.json
@@ -59,18 +65,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
59
65
  ```
60
66
 
61
67
  ### Running our CI test suite
68
+
62
69
  You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
70
+
63
71
  ```bash
64
72
  airbyte-ci connectors --name=source-kyriba test
65
73
  ```
66
74
 
67
75
  ### Customizing acceptance Tests
76
+
68
77
  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.
69
78
  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.
70
79
 
71
80
  ### Dependency Management
72
- All of your dependencies should be managed via Poetry.
81
+
82
+ All of your dependencies should be managed via Poetry.
73
83
  To add a new dependency, run:
84
+
74
85
  ```bash
75
86
  poetry add <package-name>
76
87
  ```
@@ -78,14 +89,16 @@ poetry add <package-name>
78
89
  Please commit the changes to `pyproject.toml` and `poetry.lock` files.
79
90
 
80
91
  ## Publishing a new version of the connector
92
+
81
93
  You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
94
+
82
95
  1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-kyriba test`
83
- 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)):
84
- - bump the `dockerImageTag` value in in `metadata.yaml`
85
- - bump the `version` value in `pyproject.toml`
96
+ 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)):
97
+ - bump the `dockerImageTag` value in in `metadata.yaml`
98
+ - bump the `version` value in `pyproject.toml`
86
99
  3. Make sure the `metadata.yaml` content is up to date.
87
100
  4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/kyriba.md`).
88
101
  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).
89
102
  6. Pat yourself on the back for being an awesome contributor.
90
103
  7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
91
- 8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
104
+ 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.3 → airbyte_source_kyriba-0.1.4}/pyproject.toml RENAMED
@@ -5,7 +5,7 @@ requires = [
5
5
  build-backend = "poetry.core.masonry.api"
6
6
 
7
7
  [tool.poetry]
8
- version = "0.1.3"
8
+ version = "0.1.4"
9
9
  name = "airbyte-source-kyriba"
10
10
  description = "Source implementation for Kyriba."
11
11
  authors = [