| Name | tap-instantly-ai JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | `tap-instantly-ai` is a Singer tap for InstantlyAI, built with the Meltano Singer SDK. |
| upload_time | 2024-02-19 11:30:32 |
| maintainer | |
| docs_url | None |
| author | Barbora Drinkova |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
elt
instantlyai
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-instantly-ai
`tap-instantly-ai` is a Singer tap for InstantlyAI.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
<!--
Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
## Installation
Install from PyPi:
```bash
pipx install tap-instantly-ai
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/tap-instantly-ai.git@main
```
-->
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
## Settings
| Setting | Required | Default | Description |
|:--------------------|:--------:|:-------:|:------------|
| api_key | True | None | The API key to authenticate against the API service |
| start_date | True | None | The earliest record date to sync |
| 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-instantly-ai --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
See https://developer.instantly.ai/introduction.
## Usage
You can easily run `tap-instantly-ai` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-instantly-ai --version
tap-instantly-ai --help
tap-instantly-ai --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-instantly-ai` CLI interface directly using `poetry run`:
```bash
poetry run tap-instantly-ai --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-instantly-ai
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-instantly-ai --version
# OR run a test `elt` pipeline:
meltano elt tap-instantly-ai 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": "",
"name": "tap-instantly-ai",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ELT,InstantlyAI",
"author": "Barbora Drinkova",
"author_email": "barbora.drinkova@strv.com",
"download_url": "https://files.pythonhosted.org/packages/1c/60/da9aa61f88d5a18b30ffd5fba07359c5d5b975185bb4d6a3b83535c54f97/tap_instantly_ai-0.0.1.tar.gz",
"platform": null,
"description": "# tap-instantly-ai\n\n`tap-instantly-ai` is a Singer tap for InstantlyAI.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n<!--\n\nDeveloper TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-instantly-ai\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/tap-instantly-ai.git@main\n```\n\n-->\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| api_key | True | None | The API key to authenticate against the API service |\n| start_date | True | None | The earliest record date to sync |\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-instantly-ai --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\nSee https://developer.instantly.ai/introduction.\n\n## Usage\n\nYou can easily run `tap-instantly-ai` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-instantly-ai --version\ntap-instantly-ai --help\ntap-instantly-ai --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-instantly-ai` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-instantly-ai --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-instantly-ai\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-instantly-ai --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-instantly-ai 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",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "`tap-instantly-ai` is a Singer tap for InstantlyAI, built with the Meltano Singer SDK.",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"elt",
"instantlyai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d67a86480997fea4b696ed1b3c8c3935dda63fea3315d6f0d230dfc11f8da2b8",
"md5": "8acebf6914efbf47814729efe38a9764",
"sha256": "3813faad1cbf42300ebd001c7f84d85a69126bff11ade1e54b20863fbed947e5"
},
"downloads": -1,
"filename": "tap_instantly_ai-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8acebf6914efbf47814729efe38a9764",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12254,
"upload_time": "2024-02-19T11:30:30",
"upload_time_iso_8601": "2024-02-19T11:30:30.604633Z",
"url": "https://files.pythonhosted.org/packages/d6/7a/86480997fea4b696ed1b3c8c3935dda63fea3315d6f0d230dfc11f8da2b8/tap_instantly_ai-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c60da9aa61f88d5a18b30ffd5fba07359c5d5b975185bb4d6a3b83535c54f97",
"md5": "2aac3895747ca62f966e984196b6f915",
"sha256": "3669576376f06fba67c41a440dbbe1e76d213cee4e30755a3a2eb7521a355616"
},
"downloads": -1,
"filename": "tap_instantly_ai-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2aac3895747ca62f966e984196b6f915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10852,
"upload_time": "2024-02-19T11:30:32",
"upload_time_iso_8601": "2024-02-19T11:30:32.218797Z",
"url": "https://files.pythonhosted.org/packages/1c/60/da9aa61f88d5a18b30ffd5fba07359c5d5b975185bb4d6a3b83535c54f97/tap_instantly_ai-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-19 11:30:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-instantly-ai"
}
