| Name | tap-socketdev JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | Singer tap for Socket, built with the Meltano SDK for Singer Taps. |
| upload_time | 2025-08-19 05:30:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
elt
socket
singer.io
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<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
| Setting | Required | Default | Description |
| :--------- | :------- | :------ | :--------------------------------- |
| api_key | True | None | API Key for Socket |
| start_date | False | None | Earliest datetime to get data from |
A full list of supported settings and capabilities is available by running: `tap-socketdev --about`
### Builtin Settings
The following settings are available to all taps.
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an additional dependency (through the `singer-sdk` `faker` extra or directly). |
| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
| 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. |
| batch_config | False | None | Configuration for BATCH message capabilities. |
| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
| batch_config.encoding.format | False | None | Format to use for batch files. |
| batch_config.encoding.compression | False | None | Compression format to use for batch files. |
| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
| batch_config.storage.root | False | None | Root path to use when writing batch files. |
| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
### Source Authentication and Authorization
- [Creating and Managing API Tokens](https://docs.socket.dev/reference/creating-and-managing-api-tokens).
## 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
### Initialize your Development Environment
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync
```
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
uvx pytest
```
You can also test the `tap-socketdev` CLI interface directly using `uv run`:
```bash
uv 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.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
uv tool 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 EL pipeline:
meltano run 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": null,
"name": "tap-socketdev",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "ELT, Socket, singer.io",
"author": null,
"author_email": "Edgar Ram\u00edrez-Mondrag\u00f3n <edgarrm358@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/91/88/afc163e36cd09b91bd4d3afb7ac789b7cb5ac5f22acefede900c7d3b2bb4/tap_socketdev-0.4.0.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| Setting | Required | Default | Description |\n| :--------- | :------- | :------ | :--------------------------------- |\n| api_key | True | None | API Key for Socket |\n| start_date | False | None | Earliest datetime to get data from |\n\nA full list of supported settings and capabilities is available by running: `tap-socketdev --about`\n\n### Builtin Settings\n\nThe following settings are available to all taps.\n\n| Setting | Required | Default | Description |\n| :-------------------------------- | :------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\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| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an additional dependency (through the `singer-sdk` `faker` extra or directly). |\n| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |\n| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |\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| batch_config | False | None | Configuration for BATCH message capabilities. |\n| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |\n| batch_config.encoding.format | False | None | Format to use for batch files. |\n| batch_config.encoding.compression | False | None | Compression format to use for batch files. |\n| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |\n| batch_config.storage.root | False | None | Root path to use when writing batch files. |\n| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |\n\n### Source Authentication and Authorization\n\n- [Creating and Managing API Tokens](https://docs.socket.dev/reference/creating-and-managing-api-tokens).\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### Initialize your Development Environment\n\n```bash\ncurl -LsSf https://astral.sh/uv/install.sh | sh # or see https://docs.astral.sh/uv/getting-started/installation/\nuv sync\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and then run:\n\n```bash\nuvx pytest\n```\n\nYou can also test the `tap-socketdev` CLI interface directly using `uv run`:\n\n```bash\nuv 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.\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\nuv tool 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 EL pipeline:\nmeltano run 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",
"bugtrack_url": null,
"license": null,
"summary": "Singer tap for Socket, built with the Meltano SDK for Singer Taps.",
"version": "0.4.0",
"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",
" socket",
" singer.io"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c782e341a2fddc398b31a0d60517f5aed392c2370349f6b3f1ccb2f9237b65bd",
"md5": "dc7608968cbd61151c2c12c21cedab02",
"sha256": "91a751ff35f519c99c63b186e926242c82ed2cc383a8bebf73ef038c13fcd5d0"
},
"downloads": -1,
"filename": "tap_socketdev-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc7608968cbd61151c2c12c21cedab02",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 10016,
"upload_time": "2025-08-19T05:30:29",
"upload_time_iso_8601": "2025-08-19T05:30:29.282880Z",
"url": "https://files.pythonhosted.org/packages/c7/82/e341a2fddc398b31a0d60517f5aed392c2370349f6b3f1ccb2f9237b65bd/tap_socketdev-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9188afc163e36cd09b91bd4d3afb7ac789b7cb5ac5f22acefede900c7d3b2bb4",
"md5": "89f8ee3fd03b637409ed9e3c94ce67fd",
"sha256": "3686bf1f237b1665ba41cda85fa73a9711791761ab0f6ea45cc1b76b5a169124"
},
"downloads": -1,
"filename": "tap_socketdev-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "89f8ee3fd03b637409ed9e3c94ce67fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 68908,
"upload_time": "2025-08-19T05:30:30",
"upload_time_iso_8601": "2025-08-19T05:30:30.637446Z",
"url": "https://files.pythonhosted.org/packages/91/88/afc163e36cd09b91bd4d3afb7ac789b7cb5ac5f22acefede900c7d3b2bb4/tap_socketdev-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 05:30:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edgarrmondragon",
"github_project": "tap-socketdev#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tap-socketdev"
}
