<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
uv tool 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.
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 `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": null,
"name": "tap-socketdev",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ELT, singer.io, Socket",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/6e/b6f6be4a94c57ffc887403d3a98788f30017eccea479abe7b110a8b23e9e/tap_socketdev-0.3.3.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\nuv tool 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.\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 `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": "Singer tap for Socket, built with the Meltano SDK for Singer Taps.",
"version": "0.3.3",
"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": null,
"digests": {
"blake2b_256": "669307fd0260a7e5374f249d13df10bcf6cbaed4eb5af7b808029801df06dd59",
"md5": "27fcdb4f730bef226a6e2cd4fb48d188",
"sha256": "1350f03814a5e167720ff4efd6eb10f43da758d59946cef29edf6cc551264492"
},
"downloads": -1,
"filename": "tap_socketdev-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "27fcdb4f730bef226a6e2cd4fb48d188",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9938,
"upload_time": "2025-04-09T02:04:43",
"upload_time_iso_8601": "2025-04-09T02:04:43.249681Z",
"url": "https://files.pythonhosted.org/packages/66/93/07fd0260a7e5374f249d13df10bcf6cbaed4eb5af7b808029801df06dd59/tap_socketdev-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a06eb6f6be4a94c57ffc887403d3a98788f30017eccea479abe7b110a8b23e9e",
"md5": "62d19873774025ac81053713fe3cd759",
"sha256": "639580fb64c4ba037b2d696cf6258610a8b353c5b7f6b22c41a1d38cc9383e08"
},
"downloads": -1,
"filename": "tap_socketdev-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "62d19873774025ac81053713fe3cd759",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8671,
"upload_time": "2025-04-09T02:04:44",
"upload_time_iso_8601": "2025-04-09T02:04:44.640864Z",
"url": "https://files.pythonhosted.org/packages/a0/6e/b6f6be4a94c57ffc887403d3a98788f30017eccea479abe7b110a8b23e9e/tap_socketdev-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-09 02:04:44",
"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"
}
JSON
