https://github.com/somethingmorerelevant/tap-mailchimp
A meltano rewrite of the singer mailchimp tap
https://github.com/somethingmorerelevant/tap-mailchimp
Last synced: over 1 year ago
JSON representation
A meltano rewrite of the singer mailchimp tap
- Host: GitHub
- URL: https://github.com/somethingmorerelevant/tap-mailchimp
- Owner: somethingmorerelevant
- License: apache-2.0
- Created: 2023-07-19T08:50:33.000Z (almost 3 years ago)
- Default Branch: spike-auth
- Last Pushed: 2023-10-16T20:55:02.000Z (over 2 years ago)
- Last Synced: 2025-01-11T13:27:18.816Z (over 1 year ago)
- Language: Python
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-mailchimp
`tap-mailchimp` is a Singer tap for mailchimp.
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-mailchimp --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-mailchimp` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-mailchimp --version
tap-mailchimp --help
tap-mailchimp --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-mailchimp` CLI interface directly using `poetry run`:
```bash
poetry run tap-mailchimp --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-mailchimp
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-mailchimp --version
# OR run a test `elt` pipeline:
meltano elt tap-mailchimp 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.