| Name | target-redcap JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Singer target for redcap, built with the Meltano Singer SDK. |
| upload_time | 2024-08-29 15:33:40 |
| maintainer | None |
| docs_url | None |
| author | Nick Van Kuren |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
elt
redcap
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# target-redcap
`target-redcap` is a Singer target for redcap.
Build with the [Meltano Target SDK](https://sdk.meltano.com).
<!--
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 target-redcap
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/target-redcap.git@main
```
-->
## Configuration
### Accepted Config Options
<!--
Developer TODO: Provide a list of config options accepted by the target.
This section can be created by copy-pasting the CLI output from:
```
target-redcap --about --format=markdown
```
-->
A full list of supported settings and capabilities for this
target is available by running:
```bash
target-redcap --about
```
### Configure using environment variables
This Singer target 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
<!--
Developer TODO: If your target requires special access on the destination system, or any special authentication requirements, provide those here.
-->
## Usage
You can easily run `target-redcap` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Target Directly
```bash
target-redcap --version
target-redcap --help
# Test using the "Carbon Intensity" sample:
tap-carbon-intensity | target-redcap --config /path/to/target-redcap-config.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 `target-redcap` CLI interface directly using `poetry run`:
```bash
poetry run target-redcap --help
```
### Testing with [Meltano](https://meltano.com/)
_**Note:** This target 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 target-redcap
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke target-redcap --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
meltano run tap-carbon-intensity target-redcap
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the Meltano Singer SDK to
develop your own Singer taps and targets.
Raw data
{
"_id": null,
"home_page": null,
"name": "target-redcap",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ELT, redcap",
"author": "Nick Van Kuren",
"author_email": "vankurenn@chop.edu",
"download_url": "https://files.pythonhosted.org/packages/11/b8/083d29b920650511be42889bc2728b97df108f9d442cc98dfcbe7a4cbd0b/target_redcap-0.0.4.tar.gz",
"platform": null,
"description": "# target-redcap\n\n`target-redcap` is a Singer target for redcap.\n\nBuild with the [Meltano Target SDK](https://sdk.meltano.com).\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 target-redcap\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/target-redcap.git@main\n```\n\n-->\n\n## Configuration\n\n### Accepted Config Options\n\n<!--\nDeveloper TODO: Provide a list of config options accepted by the target.\n\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntarget-redcap --about --format=markdown\n```\n-->\n\nA full list of supported settings and capabilities for this\ntarget is available by running:\n\n```bash\ntarget-redcap --about\n```\n\n### Configure using environment variables\n\nThis Singer target 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<!--\nDeveloper TODO: If your target requires special access on the destination system, or any special authentication requirements, provide those here.\n-->\n\n## Usage\n\nYou can easily run `target-redcap` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Target Directly\n\n```bash\ntarget-redcap --version\ntarget-redcap --help\n# Test using the \"Carbon Intensity\" sample:\ntap-carbon-intensity | target-redcap --config /path/to/target-redcap-config.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 `target-redcap` CLI interface directly using `poetry run`:\n\n```bash\npoetry run target-redcap --help\n```\n\n### Testing with [Meltano](https://meltano.com/)\n\n_**Note:** This target 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 target-redcap\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke target-redcap --version\n# OR run a test `elt` pipeline with the Carbon Intensity sample tap:\nmeltano run tap-carbon-intensity target-redcap\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 Meltano Singer SDK to\ndevelop your own Singer taps and targets.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Singer target for redcap, built with the Meltano Singer SDK.",
"version": "0.0.4",
"project_urls": null,
"split_keywords": [
"elt",
" redcap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac40f371fa5560474a85aedb778736383c089af11972c62b0d3c4acc7c5eb8cd",
"md5": "2496933de8ef3f35b0ecf1916ed9379e",
"sha256": "9b991ab3a9c2b2f71daa17013cb9d1deb58ade215c6330cc38763fcccec0d3bd"
},
"downloads": -1,
"filename": "target_redcap-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2496933de8ef3f35b0ecf1916ed9379e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11245,
"upload_time": "2024-08-29T15:33:39",
"upload_time_iso_8601": "2024-08-29T15:33:39.554100Z",
"url": "https://files.pythonhosted.org/packages/ac/40/f371fa5560474a85aedb778736383c089af11972c62b0d3c4acc7c5eb8cd/target_redcap-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "11b8083d29b920650511be42889bc2728b97df108f9d442cc98dfcbe7a4cbd0b",
"md5": "e941c6f8a45ac17089b06b1f3635ed79",
"sha256": "5dff09d32c7c5f20b2fd5d795dfe9f2282eb71265aa13f994c4dcadbd326cc8c"
},
"downloads": -1,
"filename": "target_redcap-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "e941c6f8a45ac17089b06b1f3635ed79",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9684,
"upload_time": "2024-08-29T15:33:40",
"upload_time_iso_8601": "2024-08-29T15:33:40.855346Z",
"url": "https://files.pythonhosted.org/packages/11/b8/083d29b920650511be42889bc2728b97df108f9d442cc98dfcbe7a4cbd0b/target_redcap-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 15:33:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "target-redcap"
}
