https://github.com/ota-insight/tap-postmark
Singer tap for the postmark api
https://github.com/ota-insight/tap-postmark
Last synced: about 1 year ago
JSON representation
Singer tap for the postmark api
- Host: GitHub
- URL: https://github.com/ota-insight/tap-postmark
- Owner: OTA-Insight
- Created: 2023-01-13T14:02:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T07:32:23.000Z (about 3 years ago)
- Last Synced: 2025-02-16T13:46:56.360Z (over 1 year ago)
- Language: Python
- Size: 149 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tap-postmark
*!!! Note: this tap is under development !!!*
`tap-postmark` is a Singer tap for the [Postmark email api](https://postmarkapp.com/developer/api/overview).
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-postmark --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
A token is necessary to access the Postmark api. It can be provided under the `auth_token` config key.
## Usage
You can easily run `tap-postmark` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-postmark --version
tap-postmark --help
tap-postmark --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 `tap_jsonplaceholder/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-postmark` CLI interface directly using `poetry run`:
```bash
poetry run tap-postmark --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-postmark
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-postmark --version
# OR run a test `elt` pipeline:
meltano elt tap-postmark 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.