airbyte-source-gitlab 4.0.1__tar.gz → 4.0.3__tar.gz

{airbyte_source_gitlab-4.0.1 → airbyte_source_gitlab-4.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-gitlab
-Version: 4.0.1
+Version: 4.0.3
 Summary: Source implementation for GitLab.
 Home-page: https://airbyte.com
 License: MIT
@@ -12,7 +12,7 @@ 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,<1)
+Requires-Dist: airbyte-cdk (==0.80.0)
 Requires-Dist: vcrpy (==4.1.1)
 Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/gitlab
 Project-URL: Repository, https://github.com/airbytehq/airbyte
@@ -20,32 +20,33 @@ Description-Content-Type: text/markdown
 
 # Gitlab source connector
 
-
 This is the repository for the Gitlab source connector, written in Python.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/gitlab).
 
 ## Local development
 
 ### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
+- 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/gitlab)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_gitlab/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-gitlab spec
 poetry run source-gitlab check --config secrets/config.json
@@ -54,23 +55,28 @@ poetry run source-gitlab read --config secrets/config.json --catalog integration
 ```
 
 ### 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-gitlab build
 ```
 
 An image will be available on your host with the tag `airbyte/source-gitlab:dev`.
 
-
 ### Running as a docker container
+
 Then run any of the connector commands as follows:
+
 ```
 docker run --rm airbyte/source-gitlab:dev spec
 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
 ```
 
 ### 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-gitlab 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. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -98,14 +109,17 @@ 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-gitlab 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`
+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/gitlab.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_gitlab-4.0.1 → airbyte_source_gitlab-4.0.3}/README.md

@@ -1,31 +1,32 @@
 # Gitlab source connector
 
-
 This is the repository for the Gitlab source connector, written in Python.
 For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/gitlab).
 
 ## Local development
 
 ### Prerequisites
-* Python (~=3.9)
-* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
+- 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/gitlab)
 to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_gitlab/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-gitlab spec
 poetry run source-gitlab check --config secrets/config.json
@@ -34,23 +35,28 @@ poetry run source-gitlab read --config secrets/config.json --catalog integration
 ```
 
 ### 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-gitlab build
 ```
 
 An image will be available on your host with the tag `airbyte/source-gitlab:dev`.
 
-
 ### Running as a docker container
+
 Then run any of the connector commands as follows:
+
 ```
 docker run --rm airbyte/source-gitlab:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gitlab:dev check --config /secrets/config.json
@@ -59,18 +65,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### 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-gitlab 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. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -78,14 +89,16 @@ 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-gitlab 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`
+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/gitlab.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.
+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_gitlab-4.0.1 → airbyte_source_gitlab-4.0.3}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "4.0.1"
+version = "4.0.3"
 name = "airbyte-source-gitlab"
 description = "Source implementation for GitLab."
 authors = [
@@ -22,7 +22,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.9,<3.12"
-airbyte-cdk = "^0"
+airbyte-cdk = "0.80.0"
 vcrpy = "==4.1.1"
 
 [tool.poetry.scripts]

airbyte_source_gitlab-4.0.3/source_gitlab/schemas/branches.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "project_id": {
+      "description": "ID of the project to which this branch belongs.",
+      "type": ["null", "integer"]
+    },
+    "name": {
+      "description": "Name of the branch.",
+      "type": ["null", "string"]
+    },
+    "merged": {
+      "description": "Indicates if the changes in this branch have been merged into another branch.",
+      "type": ["null", "boolean"]
+    },
+    "protected": {
+      "description": "Indicates if the branch is protected to prevent direct pushes.",
+      "type": ["null", "boolean"]
+    },
+    "developers_can_push": {
+      "description": "Indicates if developers can push changes to this branch.",
+      "type": ["null", "boolean"]
+    },
+    "developers_can_merge": {
+      "description": "Indicates if developers can merge changes to this branch.",
+      "type": ["null", "boolean"]
+    },
+    "can_push": {
+      "description": "Indicates if the user has permission to push changes to this branch.",
+      "type": ["null", "boolean"]
+    },
+    "default": {
+      "description": "Indicates if this is the default branch of the project.",
+      "type": ["null", "boolean"]
+    },
+    "web_url": {
+      "description": "URL to view the branch in a web browser.",
+      "type": ["null", "string"]
+    },
+    "commit_id": {
+      "description": "ID of the commit associated with this branch.",
+      "type": ["null", "string"]
+    },
+    "commit": {
+      "description": "Details about the commit associated with this branch.",
+      "type": ["null", "object"],
+      "additionalProperties": true
+    }
+  }
+}

{airbyte_source_gitlab-4.0.1 → airbyte_source_gitlab-4.0.3}/source_gitlab/schemas/commits.json

@@ -3,44 +3,56 @@
   "type": "object",
   "properties": {
     "project_id": {
+      "description": "ID of the project to which the commit belongs.",
       "type": ["null", "integer"]
     },
     "id": {
+      "description": "Unique identifier of the commit.",
       "type": ["null", "string"]
     },
     "short_id": {
+      "description": "Shortened version of the commit's unique identifier.",
       "type": ["null", "string"]
     },
     "created_at": {
+      "description": "Date and time when the commit record was created.",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "parent_ids": {
+      "description": "Array of unique identifiers of parent commits if the commit has multiple parents.",
       "type": ["null", "array"],
       "items": {
         "type": ["null", "string"]
       }
     },
     "title": {
+      "description": "Title or summary of the commit message.",
       "type": ["null", "string"]
     },
     "message": {
+      "description": "Description or text message associated with the commit.",
       "type": ["null", "string"]
     },
     "author_name": {
+      "description": "Name of the author who created the commit.",
       "type": ["null", "string"]
     },
     "author_email": {
+      "description": "Email of the author who created the commit.",
       "type": ["null", "string"]
     },
     "authored_date": {
+      "description": "Date and time when the commit was authored.",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "extended_trailers": {
+      "description": "Additional information or metadata added to the commit. Eg: 'Cc' field for carbon copy email addresses.",
       "type": ["null", "object"],
       "properties": {
         "Cc": {
+          "description": "Carbon copy email addresses associated with the commit.",
           "type": ["null", "array"],
           "items": {
             "type": ["null", "string"]
@@ -49,31 +61,40 @@
       }
     },
     "committer_name": {
+      "description": "Name of the committer who committed the changes.",
       "type": ["null", "string"]
     },
     "committer_email": {
+      "description": "Email of the committer who committed the changes.",
       "type": ["null", "string"]
     },
     "committed_date": {
+      "description": "Date and time when the commit was committed.",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "trailers": {
+      "description": "Metadata information provided below the commit message.",
       "type": ["null", "object"]
     },
     "web_url": {
+      "description": "URL link to view the commit details in a web browser.",
       "type": ["null", "string"]
     },
     "stats": {
+      "description": "Statistics related to the commit changes like additions, deletions, and total changes.",
       "type": ["null", "object"],
       "properties": {
         "additions": {
+          "description": "Number of lines added in the commit.",
           "type": ["null", "integer"]
         },
         "deletions": {
+          "description": "Number of lines deleted in the commit.",
           "type": ["null", "integer"]
         },
         "total": {
+          "description": "Total number of lines changed in the commit.",
           "type": ["null", "integer"]
         }
       }

{airbyte_source_gitlab-4.0.1 → airbyte_source_gitlab-4.0.3}/source_gitlab/schemas/deployments.json

@@ -3,203 +3,264 @@
   "type": "object",
   "properties": {
     "id": {
+      "description": "Unique identifier of the deployment",
       "type": ["null", "integer"]
     },
     "iid": {
+      "description": "Identification number of the deployment",
       "type": ["null", "integer"]
     },
     "status": {
+      "description": "Status of the deployment",
       "type": ["null", "string"]
     },
     "ref": {
+      "description": "Reference of the deployment",
       "type": ["null", "string"]
     },
     "sha": {
+      "description": "SHA of the deployment",
       "type": ["null", "string"]
     },
     "environment_name": {
+      "description": "Name of the environment",
       "type": ["null", "string"]
     },
     "created_at": {
+      "description": "The timestamp when the deployment was created",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "updated_at": {
+      "description": "Timestamp when the deployment was last updated",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "user": {
+      "description": "User associated with the deployment",
       "type": ["null", "object"],
       "additionalProperties": true
     },
     "user_full_name": {
+      "description": "Full name of the user associated with the deployment",
       "type": ["null", "string"]
     },
     "user_username": {
+      "description": "Username of the user associated with the deployment",
       "type": ["null", "string"]
     },
     "user_id": {
+      "description": "Unique identifier of the user associated with the deployment",
       "type": ["null", "integer"]
     },
     "environment": {
+      "description": "Environment information of the deployment",
       "type": ["null", "object"],
       "additionalProperties": true
     },
     "environment_id": {
+      "description": "Unique identifier of the environment",
       "type": ["null", "integer"]
     },
     "project_id": {
+      "description": "Unique identifier of the project",
       "type": ["null", "integer"]
     },
     "deployable": {
+      "description": "Details of the deployment job",
       "type": ["null", "object"],
       "properties": {
         "commit": {
+          "description": "Information about the commit associated with the deployment",
           "type": ["null", "object"],
           "properties": {
             "author_email": {
+              "description": "Email of the author of the commit",
               "type": ["null", "string"]
             },
             "author_name": {
+              "description": "Name of the author of the commit",
               "type": ["null", "string"]
             },
             "created_at": {
+              "description": "Timestamp when the commit was created",
               "type": ["null", "string"],
               "format": "date-time"
             },
             "id": {
+              "description": "Unique identifier of the commit",
               "type": ["null", "string"]
             },
             "message": {
+              "description": "Message associated with the commit",
               "type": ["null", "string"]
             },
             "short_id": {
+              "description": "Short identifier of the commit",
               "type": ["null", "string"]
             },
             "title": {
+              "description": "Title of the commit",
               "type": ["null", "string"]
             }
           }
         },
         "coverage": {
+          "description": "Coverage information of the deployment",
           "type": ["null", "string"]
         },
         "created_at": {
+          "description": "Timestamp when the deployment was created",
           "type": ["null", "string"],
           "format": "date-time"
         },
         "finished_at": {
+          "description": "Timestamp when the deployment was finished",
           "type": ["null", "string"],
           "format": "date-time"
         },
         "id": {
+          "description": "Unique identifier of the deployment",
           "type": ["null", "integer"]
         },
         "name": {
+          "description": "Name of the deployment",
           "type": ["null", "string"]
         },
         "ref": {
+          "description": "Reference of the deployment",
           "type": ["null", "string"]
         },
         "runner": {
+          "description": "Runner information for the deployment",
           "type": ["null", "string"]
         },
         "stage": {
+          "description": "Stage of the deployment",
           "type": ["null", "string"]
         },
         "started_at": {
+          "description": "Timestamp when the deployment was started",
           "type": ["null", "string"],
           "format": "date-time"
         },
         "status": {
+          "description": "Status of the deployment",
           "type": ["null", "string"]
         },
         "tag": {
+          "description": "Tag information for the deployment",
           "type": ["null", "boolean"]
         },
         "project": {
+          "description": "Details of the project where the deployment occurred",
           "type": ["null", "object"],
           "properties": {
             "ci_job_token_scope_enabled": {
+              "description": "Flag indicating if the CI job token scope is enabled for the project",
               "type": ["null", "boolean"]
             }
           }
         },
         "user": {
+          "description": "User associated with the deployment",
           "type": ["null", "object"],
           "properties": {
             "id": {
+              "description": "Unique identifier of the user",
               "type": ["null", "integer"]
             },
             "name": {
+              "description": "Name of the user",
               "type": ["null", "string"]
             },
             "username": {
+              "description": "Username of the user",
               "type": ["null", "string"]
             },
             "state": {
+              "description": "State information of the user",
               "type": ["null", "string"]
             },
             "avatar_url": {
+              "description": "URL of the user's avatar",
               "type": ["null", "string"]
             },
             "web_url": {
+              "description": "URL for accessing the user's information",
               "type": ["null", "string"]
             },
             "created_at": {
+              "description": "Timestamp when the user was created",
               "type": ["null", "string"],
               "format": "date-time"
             },
             "bio": {
+              "description": "Bio information of the user",
               "type": ["null", "string"]
             },
             "location": {
+              "description": "Location information of the user",
               "type": ["null", "string"]
             },
             "public_email": {
+              "description": "Public email of the user",
               "type": ["null", "string"]
             },
             "skype": {
+              "description": "Skype ID of the user",
               "type": ["null", "string"]
             },
             "linkedin": {
+              "description": "Linkedin profile of the user",
               "type": ["null", "string"]
             },
             "twitter": {
+              "description": "Twitter handle of the user",
               "type": ["null", "string"]
             },
             "website_url": {
+              "description": "URL for the user's website",
               "type": ["null", "string"]
             },
             "organization": {
+              "description": "Organization information of the user",
               "type": ["null", "string"]
             }
           }
         },
         "pipeline": {
+          "description": "Details of the pipeline used for the deployment",
           "type": ["null", "object"],
           "properties": {
             "created_at": {
+              "description": "Timestamp when the pipeline associated with the deployment was created",
               "type": ["null", "string"],
               "format": "date-time"
             },
             "id": {
+              "description": "Unique identifier of the pipeline",
               "type": ["null", "integer"]
             },
             "ref": {
+              "description": "Reference of the pipeline",
               "type": ["null", "string"]
             },
             "sha": {
+              "description": "SHA of the pipeline",
               "type": ["null", "string"]
             },
             "status": {
+              "description": "Status of the pipeline",
               "type": ["null", "string"]
             },
             "updated_at": {
+              "description": "Timestamp when the pipeline associated with the deployment was last updated",
               "type": ["null", "string"],
               "format": "date-time"
             },
             "web_url": {
+              "description": "URL for accessing the pipeline in a web browser",
               "type": ["null", "string"]
             }
           }