# `tap-pulumi-cloud`
Singer tap for Pulumi Cloud.
Built with the [Meltano Singer SDK](https://sdk.meltano.com).
## Capabilities
* `catalog`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
> **Note**
> Incremental replication is not supported by any streams, so the `state` capability is not supported by this tap.
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| token | True | None | API Token for Pulumi Cloud |
| organizations | True | None | List of organizations to sync |
| start_date | False | None | Earliest datetime to get data from |
| requests_cache | False | None | Cache configuration for HTTP requests |
| 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. |
A full list of supported settings and capabilities is available by running: `tap-pulumi-cloud --about`
### Source Authentication and Authorization
See https://www.pulumi.com/docs/reference/cloud-rest-api/#authentication.
## Usage
You can easily run `tap-pulumi-cloud` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-pulumi-cloud --version
tap-pulumi-cloud --help
tap-pulumi-cloud --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### 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-pulumi-cloud` CLI interface directly using `poetry run`:
```bash
poetry run tap-pulumi-cloud --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
pipx install meltano
# Initialize meltano within this directory
cd tap-pulumi-cloud
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-pulumi-cloud --version
# OR run a pipeline:
meltano run tap-pulumi-cloud 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": "https://github.com/edgarrmondragon/tap-pulumi-cloud",
"name": "tap-pulumi-cloud",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "ELT, singer.io, Pulumi Cloud",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/98/e39a4dfadea408f79e1fba4ecf66b21ffc077fc7bdf18bc717d361eb7e2f/tap_pulumi_cloud-0.2.0.tar.gz",
"platform": null,
"description": "# `tap-pulumi-cloud`\n\nSinger tap for Pulumi Cloud.\n\nBuilt with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n## Capabilities\n\n* `catalog`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n> **Note**\n> Incremental replication is not supported by any streams, so the `state` capability is not supported by this tap.\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| token | True | None | API Token for Pulumi Cloud |\n| organizations | True | None | List of organizations to sync |\n| start_date | False | None | Earliest datetime to get data from |\n| requests_cache | False | None | Cache configuration for HTTP requests |\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\nA full list of supported settings and capabilities is available by running: `tap-pulumi-cloud --about`\n\n### Source Authentication and Authorization\n\nSee https://www.pulumi.com/docs/reference/cloud-rest-api/#authentication.\n\n## Usage\n\nYou can easily run `tap-pulumi-cloud` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-pulumi-cloud --version\ntap-pulumi-cloud --help\ntap-pulumi-cloud --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\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 then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-pulumi-cloud` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-pulumi-cloud --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\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\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-pulumi-cloud\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-pulumi-cloud --version\n\n# OR run a pipeline:\nmeltano run tap-pulumi-cloud 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-pulumi-cloud` is a Singer tap for Pulumi Cloud, built with the Meltano SDK for Singer Taps.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/edgarrmondragon/tap-pulumi-cloud#readme",
"Homepage": "https://github.com/edgarrmondragon/tap-pulumi-cloud",
"Repository": "https://github.com/edgarrmondragon/tap-pulumi-cloud"
},
"split_keywords": [
"elt",
" singer.io",
" pulumi cloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "111ceb5d1bbc5e7a029212cff170dbb066b07d2fb687dd875400fcf8d2b772e3",
"md5": "a599b60b641e3b065bb96cc6d5bb79cc",
"sha256": "64b25f72241bf25942b320a2db9cc10712a668628c5ca88d0c7b7a4dab9bd601"
},
"downloads": -1,
"filename": "tap_pulumi_cloud-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a599b60b641e3b065bb96cc6d5bb79cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 11024,
"upload_time": "2024-08-08T00:37:30",
"upload_time_iso_8601": "2024-08-08T00:37:30.032240Z",
"url": "https://files.pythonhosted.org/packages/11/1c/eb5d1bbc5e7a029212cff170dbb066b07d2fb687dd875400fcf8d2b772e3/tap_pulumi_cloud-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee98e39a4dfadea408f79e1fba4ecf66b21ffc077fc7bdf18bc717d361eb7e2f",
"md5": "1cfb530f93c1c4aee373f9a9d6327403",
"sha256": "2650ae835be4ded677232ddbd8804b6981e5386ea59e274c7856a3af11474d70"
},
"downloads": -1,
"filename": "tap_pulumi_cloud-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1cfb530f93c1c4aee373f9a9d6327403",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 9482,
"upload_time": "2024-08-08T00:37:31",
"upload_time_iso_8601": "2024-08-08T00:37:31.318433Z",
"url": "https://files.pythonhosted.org/packages/ee/98/e39a4dfadea408f79e1fba4ecf66b21ffc077fc7bdf18bc717d361eb7e2f/tap_pulumi_cloud-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 00:37:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-pulumi-cloud",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-pulumi-cloud"
}
JSON
