<div align="center">
# tap-planetscaleapi
<div>
<a href="https://pypi.org/p/tap-planetscaleapi/">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/tap-planetscaleapi">
</a>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-planetscaleapi/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-planetscaleapi/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-planetscaleapi/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-planetscaleapi"/>
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://pypi.org/p/tap-planetscaleapi/">
<img alt="Python versions" src="https://img.shields.io/pypi/pyversions/tap-planetscaleapi"/>
</a>
</div>
`tap-planetscaleapi` is a Singer tap for [PlanetScale API](https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
</div>
## Installation
Install from PyPi:
```bash
pipx install tap-planetscaleapi
```
Install from GitHub:
```bash
pipx install git+https://github.com/edgarrmondragon/tap-planetscaleapi.git@main
```
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| service_token_id | True | None | The service token ID, visible on the service token page |
| service_token | True | None | The service token value |
| 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-planetscaleapi --about`
## Supported Python Versions
* 3.8
* 3.9
* 3.10
* 3.11
* 3.12
A full list of supported settings and capabilities for this tap is available by running:
```bash
tap-planetscaleapi --about
```
### Configure using environment variables
This Singer tap will automatically import any environment variables within the working directory's
`.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
## Usage
You can easily run `tap-planetscaleapi` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-planetscaleapi --version
tap-planetscaleapi --help
tap-planetscaleapi --config CONFIG --discover > ./catalog.json
```
## Developer Resources
Follow these instructions to contribute to this project.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-planetscaleapi` CLI interface directly using `poetry run`:
```bash
poetry run tap-planetscaleapi --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._
<!--
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
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-planetscaleapi
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-planetscaleapi --version
# OR run a test `elt` pipeline:
meltano elt tap-planetscaleapi 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "tap-planetscaleapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ELT, PlanetScaleAPI",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b9/03/90c38e599bb7fc9a2e6680aa993de5302c916c785cbf4d6ff1867189559d/tap_planetscaleapi-0.1.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-planetscaleapi\n\n<div>\n <a href=\"https://pypi.org/p/tap-planetscaleapi/\">\n <img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/tap-planetscaleapi\">\n </a>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-planetscaleapi/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-planetscaleapi/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-planetscaleapi/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-planetscaleapi\"/>\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://pypi.org/p/tap-planetscaleapi/\">\n <img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/tap-planetscaleapi\"/>\n </a>\n</div>\n\n`tap-planetscaleapi` is a Singer tap for [PlanetScale API](https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api).\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n</div>\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-planetscaleapi\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/edgarrmondragon/tap-planetscaleapi.git@main\n```\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n* `batch`\n\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| service_token_id | True | None | The service token ID, visible on the service token page |\n| service_token | True | None | The service token value |\n| 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). |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth| False | None | The max depth to flatten schemas. |\n| batch_config | False | None | |\n\nA full list of supported settings and capabilities is available by running: `tap-planetscaleapi --about`\n\n## Supported Python Versions\n\n* 3.8\n* 3.9\n* 3.10\n* 3.11\n* 3.12\n\nA full list of supported settings and capabilities for this tap is available by running:\n\n```bash\ntap-planetscaleapi --about\n```\n\n### Configure using environment variables\n\nThis Singer tap will automatically import any environment variables within the working directory's\n`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching\nenvironment variable is set either in the terminal context or in the `.env` file.\n\n### Source Authentication and Authorization\n\n## Usage\n\nYou can easily run `tap-planetscaleapi` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-planetscaleapi --version\ntap-planetscaleapi --help\ntap-planetscaleapi --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\nFollow these instructions to contribute to this project.\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-planetscaleapi` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-planetscaleapi --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\n<!--\nDeveloper TODO:\nYour project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any \"TODO\" items listed in\nthe file.\n-->\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-planetscaleapi\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-planetscaleapi --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-planetscaleapi target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "`tap-planetscaleapi` is a Singer tap for PlanetScaleAPI, built with the Meltano Singer SDK.",
"version": "0.1.3",
"project_urls": {
"Issue Tracker": "https://github.com/edgarrmondragon/tap-planetscalepi/issues",
"documentation": "https://github.com/edgarrmondragon/tap-planetscalepi#",
"homepage": "https://github.com/edgarrmondragon/tap-planetscalepi",
"repository": "https://github.com/edgarrmondragon/tap-planetscalepi"
},
"split_keywords": [
"elt",
" planetscaleapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86d555cd22b19ad0792f7c818779942ffe25e9e3ed618c314f9e5c7881c4bd00",
"md5": "02094869b2358b7c0d3267fc26f6e0f5",
"sha256": "2de428ea59124af4c3d06f699b087c2b01f5deb7f0ed5332d31084d6d3f0cc2e"
},
"downloads": -1,
"filename": "tap_planetscaleapi-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "02094869b2358b7c0d3267fc26f6e0f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11366,
"upload_time": "2024-06-25T17:05:13",
"upload_time_iso_8601": "2024-06-25T17:05:13.636485Z",
"url": "https://files.pythonhosted.org/packages/86/d5/55cd22b19ad0792f7c818779942ffe25e9e3ed618c314f9e5c7881c4bd00/tap_planetscaleapi-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b90390c38e599bb7fc9a2e6680aa993de5302c916c785cbf4d6ff1867189559d",
"md5": "2a4ebf81ccec5dced994f98f67c0fc1f",
"sha256": "8d9f38531c291c81063537835338bdf67e1e99d8c4d6b6e9fce2e2f1c5c8b61a"
},
"downloads": -1,
"filename": "tap_planetscaleapi-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "2a4ebf81ccec5dced994f98f67c0fc1f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11480,
"upload_time": "2024-06-25T17:05:14",
"upload_time_iso_8601": "2024-06-25T17:05:14.867759Z",
"url": "https://files.pythonhosted.org/packages/b9/03/90c38e599bb7fc9a2e6680aa993de5302c916c785cbf4d6ff1867189559d/tap_planetscaleapi-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 17:05:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-planetscalepi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "tap-planetscaleapi"
}
JSON
