| Name | tap-octopus JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Singer tap for Octopus, built with the Meltano Singer SDK. |
| upload_time | 2024-08-20 12:33:49 |
| maintainer | None |
| docs_url | None |
| author | damien harley |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
elt
octopus
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-octopus
`tap-octopus` is a Singer tap for Octopus.
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-octopus
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/tap-octopus.git@main
```
-->
## Configuration
### Accepted Config Options
<!--
Developer TODO: Provide a list of config options accepted by the tap.
This section can be created by copy-pasting the CLI output from:
```
tap-octopus --about --format=markdown
```
-->
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-octopus --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
<!--
Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.
-->
## Usage
You can easily run `tap-octopus` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-octopus --version
tap-octopus --help
tap-octopus --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-octopus` CLI interface directly using `poetry run`:
```bash
poetry run tap-octopus --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-octopus
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-octopus --version
# OR run a test `elt` pipeline:
meltano elt tap-octopus 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-octopus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ELT, Octopus",
"author": "damien harley",
"author_email": "damienkharley@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ae/fa/3d8bf5079fe09a229269acf0798f928d32b3eb2b3917261ce7c478d3e7f1/tap_octopus-0.0.2.tar.gz",
"platform": null,
"description": "# tap-octopus\n\n`tap-octopus` is a Singer tap for Octopus.\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-octopus\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/tap-octopus.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 tap.\n\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntap-octopus --about --format=markdown\n```\n-->\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-octopus --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<!--\nDeveloper TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.\n-->\n\n## Usage\n\nYou can easily run `tap-octopus` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-octopus --version\ntap-octopus --help\ntap-octopus --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-octopus` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-octopus --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-octopus\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-octopus --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-octopus 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": "Singer tap for Octopus, built with the Meltano Singer SDK.",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"elt",
" octopus"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "072df21177c9da6a9d2ee150e749790a7a0b0f3a4903d537ac94a039335f7c2b",
"md5": "960aa8549c2fae0129b7c129131de1de",
"sha256": "a83f69896eb53de1c5f0fcb89d38efa54f5668a8e0b39485c79edc5e3f02a1c3"
},
"downloads": -1,
"filename": "tap_octopus-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "960aa8549c2fae0129b7c129131de1de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11233,
"upload_time": "2024-08-20T12:33:48",
"upload_time_iso_8601": "2024-08-20T12:33:48.558944Z",
"url": "https://files.pythonhosted.org/packages/07/2d/f21177c9da6a9d2ee150e749790a7a0b0f3a4903d537ac94a039335f7c2b/tap_octopus-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aefa3d8bf5079fe09a229269acf0798f928d32b3eb2b3917261ce7c478d3e7f1",
"md5": "b2dedfc19125dcc0f1573df185d883b7",
"sha256": "a0e69fd5f7577e4f43331869331816b6f5e6157824e91653cb0b9cc31cf43174"
},
"downloads": -1,
"filename": "tap_octopus-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b2dedfc19125dcc0f1573df185d883b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9672,
"upload_time": "2024-08-20T12:33:49",
"upload_time_iso_8601": "2024-08-20T12:33:49.878845Z",
"url": "https://files.pythonhosted.org/packages/ae/fa/3d8bf5079fe09a229269acf0798f928d32b3eb2b3917261ce7c478d3e7f1/tap_octopus-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 12:33:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tap-octopus"
}
