https://github.com/lumapps/tap-netsuitesuiteql
tap-netsuitesuiteql a Singer tap for netsuite using suiteql built with the Singer SDK.
https://github.com/lumapps/tap-netsuitesuiteql
netsuite singer
Last synced: 16 days ago
JSON representation
tap-netsuitesuiteql a Singer tap for netsuite using suiteql built with the Singer SDK.
- Host: GitHub
- URL: https://github.com/lumapps/tap-netsuitesuiteql
- Owner: lumapps
- License: apache-2.0
- Created: 2024-07-12T13:05:52.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2026-03-30T17:35:01.000Z (3 months ago)
- Last Synced: 2026-03-30T19:26:00.449Z (3 months ago)
- Topics: netsuite, singer
- Language: Python
- Homepage:
- Size: 173 KB
- Stars: 1
- Watchers: 14
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tap-netsuitesuiteql
`tap-netsuitesuiteql` is a Singer tap for NetsuiteSuiteQL.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-netsuitesuiteql --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
## Usage
You can easily run `tap-netsuitesuiteql` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-netsuitesuiteql --version
tap-netsuitesuiteql --help
tap-netsuitesuiteql --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-netsuitesuiteql` CLI interface directly using `poetry run`:
```bash
poetry run tap-netsuitesuiteql --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._
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-netsuitesuiteql
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-netsuitesuiteql --version
# OR run a test `elt` pipeline:
meltano elt tap-netsuitesuiteql 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.