Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgarrmondragon/tap-google-play
Singer tap for Google Play Reviews
https://github.com/edgarrmondragon/tap-google-play
elt google-play meltano singer-io singer-tap
Last synced: 22 days ago
JSON representation
Singer tap for Google Play Reviews
- Host: GitHub
- URL: https://github.com/edgarrmondragon/tap-google-play
- Owner: edgarrmondragon
- License: apache-2.0
- Created: 2023-08-31T15:36:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-29T15:49:41.000Z (2 months ago)
- Last Synced: 2024-08-30T16:35:15.393Z (2 months ago)
- Topics: elt, google-play, meltano, singer-io, singer-tap
- Language: Python
- Homepage: https://pypi.org/p/tap-google-play
- Size: 466 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-google-play
Singer tap for Google Play Reviews. Built with the [Meltano Singer SDK](https://sdk.meltano.com).
Based on [hotglue/tap-google-play](https://gitlab.com/hotglue/tap-google-play).
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| app_id | False | None | The app ID to extract reviews from. |
| app_id_list | False | None | A list of app IDs to extract reviews from. |
| start_date | False | None | The date to start extracting reviews from |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth| False | None | The max depth to flatten schemas. |
| batch_config | False | None | |
A full list of supported settings and capabilities is available by running: `tap-google-play --about`
## Usage
You can easily run `tap-google-play` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-google-play --version
tap-google-play --help
tap-google-play --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) if you haven't already.
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
uv run pytest
```
You can also test the `tap-google-play` CLI interface directly using `uv run`:
```bash
uv run tap-google-play --help
```
### Testing with [Meltano](https://www.meltano.com)
_**Note:** This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios._
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any _"TODO"_ items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
uv tool install meltano
# Install meltano
meltano config meltano set venv.backend uv
# Initialize meltano within this directory
cd tap-google-play
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-google-play --version
# OR run a test `elt` pipeline:
meltano run tap-google-play target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.