<div align="center">
# tap-socketdev
<div>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-socketdev/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-socketdev/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-socketdev/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-socketdev"/>
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://pypi.org/p/tap-socketdev/">
<img alt="Python versions" src="https://img.shields.io/pypi/pyversions/tap-socketdev"/>
</a>
</div>
Singer tap for [socket.dev](https://socket.dev).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
</div>
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
## Settings
- [ ] `Developer TODO:` Declare tap settings here.
A full list of supported settings and capabilities is available by running: `tap-socketdev --about`
### 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-socketdev` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-socketdev --version
tap-socketdev --help
tap-socketdev --config CONFIG --discover > ./catalog.json
```
## Developer Resources
- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
### 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-socketdev` CLI interface directly using `poetry run`:
```bash
poetry run tap-socketdev --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-socketdev
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-socketdev --version
# OR run a test `elt` pipeline:
meltano elt tap-socketdev 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-socketdev",
"name": "tap-socketdev",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "ELT,singer.io,Socket",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5a/00/d90ee80e51204ce550ba5c081d8b17282e0793f836bf12eebd65f9b7d948/tap_socketdev-0.2.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n \n# tap-socketdev\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-socketdev/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-socketdev/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-socketdev/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-socketdev\"/>\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://pypi.org/p/tap-socketdev/\">\n <img alt=\"Python versions\" src=\"https://img.shields.io/pypi/pyversions/tap-socketdev\"/>\n </a>\n</div>\n\nSinger tap for [socket.dev](https://socket.dev).\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n</div>\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n\n## Settings\n\n- [ ] `Developer TODO:` Declare tap settings here.\n\nA full list of supported settings and capabilities is available by running: `tap-socketdev --about`\n\n### Source Authentication and Authorization\n\n- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.\n\n## Usage\n\nYou can easily run `tap-socketdev` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-socketdev --version\ntap-socketdev --help\ntap-socketdev --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n- [ ] `Developer TODO:` As a first step, scan the entire project for the text \"`TODO:`\" and complete any recommended steps, deleting the \"TODO\" references once completed.\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-socketdev` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-socketdev --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-socketdev\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-socketdev --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-socketdev 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-socketdev` is a Singer tap for Socket, built with the Meltano SDK for Singer Taps.",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://github.com/edgarrmondragon/tap-socketdev#readme",
"Homepage": "https://github.com/edgarrmondragon/tap-socketdev",
"Repository": "https://github.com/edgarrmondragon/tap-socketdev"
},
"split_keywords": [
"elt",
"singer.io",
"socket"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ef0acd1ff8327b40f911020a588eb73b13f0f15b5e472bc715b0a08bc751ff4",
"md5": "fb48807b8a77cecd23c844d0ce82e08b",
"sha256": "ba19127f5e96e1b2c62f22013a8f61a71ce05c952d3e1152f3e4d248dd75e158"
},
"downloads": -1,
"filename": "tap_socketdev-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb48807b8a77cecd23c844d0ce82e08b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9242,
"upload_time": "2024-03-05T03:10:36",
"upload_time_iso_8601": "2024-03-05T03:10:36.703472Z",
"url": "https://files.pythonhosted.org/packages/2e/f0/acd1ff8327b40f911020a588eb73b13f0f15b5e472bc715b0a08bc751ff4/tap_socketdev-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a00d90ee80e51204ce550ba5c081d8b17282e0793f836bf12eebd65f9b7d948",
"md5": "22fbc0913c4ac3b29eff8dd2d97bb400",
"sha256": "561b9cd42895fa810c775dcf0b3b2376436f24552db5f16a6c1a11a78dcf80d4"
},
"downloads": -1,
"filename": "tap_socketdev-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "22fbc0913c4ac3b29eff8dd2d97bb400",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8138,
"upload_time": "2024-03-05T03:10:48",
"upload_time_iso_8601": "2024-03-05T03:10:48.972593Z",
"url": "https://files.pythonhosted.org/packages/5a/00/d90ee80e51204ce550ba5c081d8b17282e0793f836bf12eebd65f9b7d948/tap_socketdev-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 03:10:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-socketdev",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-socketdev"
}
JSON
