Source wikipedia-pageviews: Migrate to manifest-only (#44460)

Author: ChristoGrab

airbyte-integrations/connectors/source-wikipedia-pageviews/README.md

@@ -1,103 +1,65 @@
-# Wikipedia Pageviews Source
+# Wikipedia Pageviews source connector
 
-This is the repository for the Wikipedia Pageviews configuration based source connector.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/wikipedia-pageviews).
+This directory contains the manifest-only connector for `source-wikipedia-pageviews`.
+This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
+
+For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/wikipedia-pageviews).
 
 ## Local development
 
-### Prerequisites
+We recommend using the Connector Builder to edit this connector.
+Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
+Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
 
-* Python (`^3.9`)
-* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
+If you prefer to develop locally, you can follow the instructions below.
 
+### Building the docker image
 
+You can build any manifest-only connector with `airbyte-ci`:
 
-### Installing the connector
+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:
 
-From this connector directory, run:
 ```bash
-poetry install --with dev
+airbyte-ci connectors --name=source-wikipedia-pageviews build
 ```
 
+An image will be available on your host with the tag `airbyte/source-wikipedia-pageviews:dev`.
 
-### Create credentials
+### Creating credentials
 
 **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/wikipedia-pageviews)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` inside `source_wikipedia_pageviews/manifest.yaml` file.
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.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 `integration_tests/sample_config.json` for a sample config file.
-
-
-### Locally running the connector
-
-```
-poetry run source-wikipedia-pageviews spec
-poetry run source-wikipedia-pageviews check --config secrets/config.json
-poetry run source-wikipedia-pageviews discover --config secrets/config.json
-poetry run source-wikipedia-pageviews read --config secrets/config.json --catalog integration_tests/configured_catalog.json
-```
-
-### Running tests
 
-To run tests locally, from the connector directory run:
-
-```
-poetry run pytest tests
-```
+### Running as a docker container
 
-### Building the docker image
+Then run any of the standard source connector commands:
 
-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-wikipedia-pageviews build
-```
-
-An image will be available on your host with the tag `airbyte/source-wikipedia-pageviews:dev`.
-
-
-### Running as a docker container
-
-Then run any of the connector commands as follows:
-```
 docker run --rm airbyte/source-wikipedia-pageviews:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-wikipedia-pageviews:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-wikipedia-pageviews:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-wikipedia-pageviews:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
-### Running our CI test suite
+### Running the 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-wikipedia-pageviews 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>
+airbyte-ci connectors --name=source-wikipedia-pageviews test
 ```
 
-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-wikipedia-pageviews 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)): 
+If you want to contribute changes to `source-wikipedia-pageviews`, here's how you can do that:
+1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
+2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-wikipedia-pageviews test`
+3. 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/wikipedia-pageviews.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-integrations/connectors/source-wikipedia-pageviews/__init__.py

@@ -3,7 +3,7 @@
 connector_image: airbyte/source-wikipedia-pageviews:dev
 tests:
   spec:
-    - spec_path: "source_wikipedia_pageviews/spec.yaml"
+    - spec_path: "manifest.yaml"
   connection:
     - config_path: "secrets/config.json"
       status: "succeed"

airbyte-integrations/connectors/source-wikipedia-pageviews/acceptance-test-config.yml

@@ -1,12 +1,9 @@
-version: 2.4.0
-
+version: 4.3.0
 type: DeclarativeSource
-
 check:
   type: CheckStream
   stream_names:
     - per-article
-
 definitions:
   streams:
     per-article:
@@ -15,7 +12,8 @@ definitions:
       retriever:
         type: SimpleRetriever
         requester:
-          $ref: "#/definitions/base_requester"
+          type: HttpRequester
+          url_base: https://wikimedia.org/api/rest_v1/metrics/pageviews
           path: >-
             /per-article/{{config.project}}/{{config.access}}/{{config.agent}}/{{config.article}}/daily/{{stream_slice.start_time}}/{{stream_slice.end_time}}
           http_method: GET
@@ -48,16 +46,36 @@ definitions:
       schema_loader:
         type: InlineSchemaLoader
         schema:
-          $ref: "#/schemas/per-article"
+          type: object
+          $schema: http://json-schema.org/schema#
+          additionalProperties: true
+          properties:
+            access:
+              type: string
+            agent:
+              type: string
+            article:
+              type: string
+            granularity:
+              type: string
+            project:
+              type: string
+            timestamp:
+              type: string
+            views:
+              type: integer
+              format: int64
     top:
       type: DeclarativeStream
       name: top
       retriever:
         type: SimpleRetriever
         requester:
-          $ref: "#/definitions/base_requester"
+          type: HttpRequester
+          url_base: https://wikimedia.org/api/rest_v1/metrics/pageviews
           path: >-
-            {{ '/top/' ~ config.project ~ '/' ~ config.access ~ '/' ~ config.start[:4] ~ '/' ~ config.start[4:6] ~ '/' ~ config.start[6:8] }}
+            {{ '/top/' ~ config.project ~ '/' ~ config.access ~ '/' ~ config.start[:4]
+            ~ '/' ~ config.start[4:6] ~ '/' ~ config.start[6:8] }}
           http_method: GET
           request_headers:
             "User-Agent": "AirbyteWikipediaPageviewsConnector/1.0"
@@ -70,15 +88,148 @@ definitions:
       schema_loader:
         type: InlineSchemaLoader
         schema:
-          $ref: "#/schemas/top"
+          type: object
+          $schema: http://json-schema.org/schema#
+          additionalProperties: true
+          properties:
+            access:
+              type: string
+            articles:
+              type: array
+              items:
+                type: object
+                properties:
+                  article:
+                    type: string
+                  rank:
+                    type: integer
+                    format: int32
+                  views:
+                    type: integer
+                    format: int64
+            day:
+              type: string
+            month:
+              type: string
+            project:
+              type: string
+            year:
+              type: string
+            timestamp:
+              type: string
   base_requester:
     type: HttpRequester
     url_base: https://wikimedia.org/api/rest_v1/metrics/pageviews
-
 streams:
-  - $ref: "#/definitions/streams/per-article"
-  - $ref: "#/definitions/streams/top"
-
+  - type: DeclarativeStream
+    name: per-article
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://wikimedia.org/api/rest_v1/metrics/pageviews
+        path: >-
+          /per-article/{{config.project}}/{{config.access}}/{{config.agent}}/{{config.article}}/daily/{{stream_slice.start_time}}/{{stream_slice.end_time}}
+        http_method: GET
+        request_headers:
+          "User-Agent": "AirbyteWikipediaPageviewsConnector/1.0"
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - items
+    incremental_sync:
+      type: DatetimeBasedCursor
+      cursor_field: timestamp
+      name: per-article
+      cursor_datetime_formats:
+        - "%Y%m%d"
+        - "%Y%m%d%H"
+      datetime_format: "%Y%m%d"
+      start_datetime:
+        type: MinMaxDatetime
+        datetime: "{{config.start}}"
+        datetime_format: "%Y%m%d"
+      end_datetime:
+        type: MinMaxDatetime
+        datetime: "{{config.end}}"
+        datetime_format: "%Y%m%d"
+      step: P1D
+      cursor_granularity: P1D
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        type: object
+        $schema: http://json-schema.org/schema#
+        additionalProperties: true
+        properties:
+          access:
+            type: string
+          agent:
+            type: string
+          article:
+            type: string
+          granularity:
+            type: string
+          project:
+            type: string
+          timestamp:
+            type: string
+          views:
+            type: integer
+            format: int64
+  - type: DeclarativeStream
+    name: top
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://wikimedia.org/api/rest_v1/metrics/pageviews
+        path: >-
+          {{ '/top/' ~ config.project ~ '/' ~ config.access ~ '/' ~ config.start[:4]
+          ~ '/' ~ config.start[4:6] ~ '/' ~ config.start[6:8] }}
+        http_method: GET
+        request_headers:
+          "User-Agent": "AirbyteWikipediaPageviewsConnector/1.0"
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - items
+    schema_loader:
+      type: InlineSchemaLoader
+      schema:
+        type: object
+        $schema: http://json-schema.org/schema#
+        additionalProperties: true
+        properties:
+          access:
+            type: string
+          articles:
+            type: array
+            items:
+              type: object
+              properties:
+                article:
+                  type: string
+                rank:
+                  type: integer
+                  format: int32
+                views:
+                  type: integer
+                  format: int64
+          day:
+            type: string
+          month:
+            type: string
+          project:
+            type: string
+          year:
+            type: string
+          timestamp:
+            type: string
 spec:
   type: Spec
   connection_specification:
@@ -142,7 +293,9 @@ spec:
       end:
         type: string
         title: End
-        description: The date of the last day to include, in YYYYMMDD or YYYYMMDDHH format.
+        description:
+          The date of the last day to include, in YYYYMMDD or YYYYMMDDHH
+          format.
         order: 4
       project:
         type: string
@@ -163,12 +316,10 @@ spec:
           format. Also serves as the date to retrieve data for the top articles.
         order: 6
     additionalProperties: true
-
 metadata:
   autoImportSchema:
     per-article: false
     top: false
-
 schemas:
   per-article:
     type: object