| Name | kingalban-tap-userflow JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | `tap-userflow` is a Singer tap for UserFlow, built with the Meltano Singer SDK. |
| upload_time | 2024-02-26 10:28:24 |
| maintainer | |
| docs_url | None |
| author | Alban King |
| requires_python | >=3.8,<4 |
| license | Apache-2.0 |
| keywords |
elt
userflow
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-userflow
`tap-userflow` is a Singer tap for UserFlow.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Installation
Install from PyPi:
```bash
pip install kingalban-tap-userflow
```
Install from GitHub:
```bash
pipx install git+https://github.com/kingalban/tap-userflow.git@main
```
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-userflow --about
```
### Example Config File
```json
{
"auth_token": "<userflow-api-key>"
}
```
### 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
Userflow uses Bearer authentication. Follow their documentation [here](https://userflow.com/docs/api#authentication) to generate API keys.
## Usage
You can easily run `tap-userflow` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-userflow --version
tap-userflow --help
tap-userflow --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
TAP_USERFLOW_AUTH_TOKEN='<your-token-here>' poetry run pytest
```
You can also test the `tap-userflow` CLI interface directly using `poetry run`:
```bash
poetry run tap-userflow --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-userflow
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-userflow --version
# OR run a test `elt` pipeline:
meltano elt tap-userflow 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": "kingalban-tap-userflow",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "",
"keywords": "ELT,UserFlow",
"author": "Alban King",
"author_email": "kingalban@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bf/ef/0eddb2037e7d41319cc4571c8140df12bcf5ab62bd0bb4274a5640ffa120/kingalban_tap_userflow-1.2.1.tar.gz",
"platform": null,
"description": "# tap-userflow\n\n`tap-userflow` is a Singer tap for UserFlow.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npip install kingalban-tap-userflow\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/kingalban/tap-userflow.git@main\n```\n\n## Configuration\n\n### Accepted Config Options\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-userflow --about\n```\n\n### Example Config File\n\n```json\n{\n \"auth_token\": \"<userflow-api-key>\"\n}\n```\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\nUserflow uses Bearer authentication. Follow their documentation [here](https://userflow.com/docs/api#authentication) to generate API keys.\n\n## Usage\n\nYou can easily run `tap-userflow` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-userflow --version\ntap-userflow --help\ntap-userflow --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\nTAP_USERFLOW_AUTH_TOKEN='<your-token-here>' poetry run pytest\n```\n\nYou can also test the `tap-userflow` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-userflow --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-userflow\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-userflow --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-userflow 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-userflow` is a Singer tap for UserFlow, built with the Meltano Singer SDK.",
"version": "1.2.1",
"project_urls": null,
"split_keywords": [
"elt",
"userflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ee098f43ff02796998a53498685ffc9d8c051720b1e80d194636fde0e8f3729",
"md5": "21bcb20ffc3f892dc87fb332df048c58",
"sha256": "371505618e8719701d6a900ca4e62ab555252fbc5150f017d66b791c69317977"
},
"downloads": -1,
"filename": "kingalban_tap_userflow-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21bcb20ffc3f892dc87fb332df048c58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4",
"size": 15081,
"upload_time": "2024-02-26T10:28:22",
"upload_time_iso_8601": "2024-02-26T10:28:22.974361Z",
"url": "https://files.pythonhosted.org/packages/3e/e0/98f43ff02796998a53498685ffc9d8c051720b1e80d194636fde0e8f3729/kingalban_tap_userflow-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfef0eddb2037e7d41319cc4571c8140df12bcf5ab62bd0bb4274a5640ffa120",
"md5": "5afa59732f1131829105aa5b5e1ceecd",
"sha256": "1ad5528feda4faf9ffbfb8df186046bf9c8789630c0c57a9b65995a515aa1715"
},
"downloads": -1,
"filename": "kingalban_tap_userflow-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "5afa59732f1131829105aa5b5e1ceecd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 12908,
"upload_time": "2024-02-26T10:28:24",
"upload_time_iso_8601": "2024-02-26T10:28:24.608594Z",
"url": "https://files.pythonhosted.org/packages/bf/ef/0eddb2037e7d41319cc4571c8140df12bcf5ab62bd0bb4274a5640ffa120/kingalban_tap_userflow-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 10:28:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "kingalban-tap-userflow"
}
