Skip to content

Commit

Permalink
V0 1 2 update readme (#4)
Browse files Browse the repository at this point in the history
* fix readme

* add home page to readme
  • Loading branch information
haleemur authored Feb 26, 2024
1 parent be59692 commit e99fd73
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ The following streams can be integrated using this tap:
* stats_by_dimension_gcm
* stats_by_dimension_installs
* stats_by_dimension_ratings
* stats_by_dimension_ratings_v2
* stats_by_dimension_retained_installers
* stats_overview_crashes
* stats_overview_gcm
* stats_overview_installs
* stats_overview_ratings
* stats_overview_ratings_v2
* reviews
* store_performance_country
* store_performance_traffic_source
Expand All @@ -27,6 +25,11 @@ _note: the streams prefixed with `stats_by_dimension` consolidate all reports by

Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

## Project Home

[https://github.com/haleemur/tap-playstore](https://github.com/haleemur/tap-playstore)

The project's source can be viewed on [github](https://github.com/haleemur/tap-playstore)

## Installation

Expand All @@ -39,7 +42,7 @@ pipx install tap-playstore
Install from GitHub:

```bash
pipx install git+https://github.com/ORG_NAME/tap-playstore.git@main
pipx install git+https://github.com/haleemur/tap-playstore.git@main
```

## Capabilities
Expand All @@ -60,12 +63,13 @@ pipx install git+https://github.com/ORG_NAME/tap-playstore.git@main
| service_account_json_file| False | None | Google Cloud Service Account JSON file |
| service_account_json_str | False | None | Google Cloud Service Account JSON string |
| start_date | True | None | The earliest record date to sync |
| end_date | False | None | The most recent record date to sync |
| bucket_name | True | None | The GCS Bucket where Play Console Reports are stored. |
| 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. |


**NOTE: At least one of [`service_account_json_file`, `service_account_json_str`] are required.**

A full list of supported settings and capabilities for this
tap is available by running:

Expand All @@ -79,12 +83,6 @@ This Singer tap will automatically import any environment variables within the w
`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the `.env` file.

### Source Authentication and Authorization

<!--
Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.
-->

## Usage

You can easily run `tap-playstore` by itself or in a pipeline using [Meltano](https://meltano.com/).
Expand Down Expand Up @@ -116,7 +114,8 @@ Tests require a `test_config.json` file to be present. Currently, running tests
**TODO:** write proper mocks for google cloud storage.

The `test_config.json` file should mimic the structure of `sample_config.json` file.
```

```json
{
"start_date": "2024-01-01",
"bucket_name": "pubsite_prod_rev_00000000000123456789",
Expand All @@ -142,12 +141,6 @@ poetry run tap-playstore --help
_**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._

<!--
Developer TODO:
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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "tap-playstore"
version = "0.1.1"
version = "0.1.2"
description = "`tap-playstore` is a Singer tap for Google PlayStore Console Reports, built with the Meltano Singer SDK."
readme = "README.md"
authors = ["Haleemur Ali <[email protected]>"]
Expand Down

0 comments on commit e99fd73

Please sign in to comment.