airbyte-source-gitlab 4.0.2__py3-none-any.whl → 4.0.3__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: airbyte-source-gitlab
3
- Version: 4.0.2
3
+ Version: 4.0.3
4
4
  Summary: Source implementation for GitLab.
5
5
  Home-page: https://airbyte.com
6
6
  License: MIT
@@ -20,32 +20,33 @@ Description-Content-Type: text/markdown
20
20
 
21
21
  # Gitlab source connector
22
22
 
23
-
24
23
  This is the repository for the Gitlab source connector, written in Python.
25
24
  For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/gitlab).
26
25
 
27
26
  ## Local development
28
27
 
29
28
  ### Prerequisites
30
- * Python (~=3.9)
31
- * Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
32
29
 
30
+ - Python (~=3.9)
31
+ - Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
33
32
 
34
33
  ### Installing the connector
34
+
35
35
  From this connector directory, run:
36
+
36
37
  ```bash
37
38
  poetry install --with dev
38
39
  ```
39
40
 
40
-
41
41
  ### Create credentials
42
+
42
43
  **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/gitlab)
43
44
  to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_gitlab/spec.yaml` file.
44
45
  Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
45
46
  See `sample_files/sample_config.json` for a sample config file.
46
47
 
47
-
48
48
  ### Locally running the connector
49
+
49
50
  ```
50
51
  poetry run source-gitlab spec
51
52
  poetry run source-gitlab check --config secrets/config.json
@@ -54,23 +55,28 @@ poetry run source-gitlab read --config secrets/config.json --catalog integration
54
55
  ```
55
56
 
56
57
  ### Running unit tests
58
+
57
59
  To run unit tests locally, from the connector directory run:
60
+
58
61
  ```
59
62
  poetry run pytest unit_tests
60
63
  ```
61
64
 
62
65
  ### Building the docker image
66
+
63
67
  1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
64
68
  2. Run the following command to build the docker image:
69
+
65
70
  ```bash
66
71
  airbyte-ci connectors --name=source-gitlab build
67
72
  ```
68
73
 
69
74
  An image will be available on your host with the tag `airbyte/source-gitlab:dev`.
70
75
 
71
-
72
76
  ### Running as a docker container
77
+
73
78
  Then run any of the connector commands as follows:
79
+
74
80
  ```
75
81
  docker run --rm airbyte/source-gitlab:dev spec
76
82
  docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gitlab:dev check --config /secrets/config.json
@@ -79,18 +85,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
79
85
  ```
80
86
 
81
87
  ### Running our CI test suite
88
+
82
89
  You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
90
+
83
91
  ```bash
84
92
  airbyte-ci connectors --name=source-gitlab test
85
93
  ```
86
94
 
87
95
  ### Customizing acceptance Tests
96
+
88
97
  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.
89
98
  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.
90
99
 
91
100
  ### Dependency Management
92
- All of your dependencies should be managed via Poetry.
101
+
102
+ All of your dependencies should be managed via Poetry.
93
103
  To add a new dependency, run:
104
+
94
105
  ```bash
95
106
  poetry add <package-name>
96
107
  ```
@@ -98,14 +109,17 @@ poetry add <package-name>
98
109
  Please commit the changes to `pyproject.toml` and `poetry.lock` files.
99
110
 
100
111
  ## Publishing a new version of the connector
112
+
101
113
  You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
114
+
102
115
  1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-gitlab test`
103
- 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)):
104
- - bump the `dockerImageTag` value in in `metadata.yaml`
105
- - bump the `version` value in `pyproject.toml`
116
+ 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)):
117
+ - bump the `dockerImageTag` value in in `metadata.yaml`
118
+ - bump the `version` value in `pyproject.toml`
106
119
  3. Make sure the `metadata.yaml` content is up to date.
107
120
  4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/gitlab.md`).
108
121
  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).
109
122
  6. Pat yourself on the back for being an awesome contributor.
110
123
  7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
111
124
  8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
125
+
@@ -29,7 +29,7 @@ source_gitlab/schemas/users.json,sha256=u-HDhMqyFHAH53_ekgW0ulAQPIJ57jEP7FjHYILd
29
29
  source_gitlab/source.py,sha256=Gc17C7D_cazqOdnVEIUNwRYYucDzNXrsGXqXnZy8CN8,1093
30
30
  source_gitlab/spec.json,sha256=0eit0zD-6kdcaNhJ1sAf0ABgIUwnlPV87Sbu3A4JvG0,6132
31
31
  source_gitlab/utils.py,sha256=idtKZiT-ILRRtpO0rxPJ1wim-mWN6ewzN_KgLCmogBs,456
32
- airbyte_source_gitlab-4.0.2.dist-info/METADATA,sha256=8gLmSZ9ycGNrOzy2pimhHiRmvZo5BWYnyQTsj3O9Fhg,5236
33
- airbyte_source_gitlab-4.0.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
34
- airbyte_source_gitlab-4.0.2.dist-info/entry_points.txt,sha256=sbp4881P3oluHtnFDy4ZCVHDfL5fIkVQhJ7vka_qzTc,55
35
- airbyte_source_gitlab-4.0.2.dist-info/RECORD,,
32
+ airbyte_source_gitlab-4.0.3.dist-info/METADATA,sha256=CFp63UOE97TIhtEpMNoGpKXe03c-LKJMpPBW3mzJdUs,5246
33
+ airbyte_source_gitlab-4.0.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
34
+ airbyte_source_gitlab-4.0.3.dist-info/entry_points.txt,sha256=sbp4881P3oluHtnFDy4ZCVHDfL5fIkVQhJ7vka_qzTc,55
35
+ airbyte_source_gitlab-4.0.3.dist-info/RECORD,,