https://github.com/yoast/singer-tap-wordpress-reviews
https://github.com/yoast/singer-tap-wordpress-reviews
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yoast/singer-tap-wordpress-reviews
- Owner: Yoast
- License: agpl-3.0
- Created: 2021-03-15T09:10:46.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T08:20:06.000Z (over 3 years ago)
- Last Synced: 2025-01-02T08:31:13.614Z (over 1 year ago)
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-wordpress-reviews
This is a [Singer](https://singer.io) tap that produces JSON-formatted data
following the [Singer
spec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).
This tap:
- Pulls raw data from [WordPress Reviews](https://wordpress.org/plugins/wordpress-seo/#reviews)
- Extracts the following resources:
- Reviews
- Outputs the schema for each resource
- Incrementally pulls data based on the input state
### Step 1: Configure
Create a file called `wp_reviews_config.json` in your working directory, following [sample_config.json](sample_config.json). The required parameters are `plugins`, which should be a list of plugins and `number` the number of reviews to fetch.
### Step 2: Install and Run
Create a virtual Python environment for this tap. This tap has been tested with Python 3.7, 3.8 and 3.9 and might run on future versions without problems.
```
python -m venv singer-wp-reviews
singer-wp-reviews/bin/python -m pip install --upgrade pip
singer-wp-reviews/bin/pip install git+https://github.com/Yoast/singer-tap-wordpress-reviews.git
```
This tap can be tested by piping the data to a local JSON target. For example:
Create a virtual Python environment with `singer-json`
```
python -m venv singer-json
singer-json/bin/python -m pip install --upgrade pip
singer-json/bin/pip install target-json
```
Test the tap:
```
singer-wp-reviews/bin/tap-wordpress-reviews -c wp_plugin_reviews_config.json | singer-json/bin/target-json
```
Copyright © 2021 Yoast