`tap-gmail` is a Singer tap for Gmail, built with the Meltano SDK for Singer Taps.
Project description
tap-gmail
tap-gmail
is a Singer tap for Gmail.
Built with the Meltano Tap SDK for Singer Taps.
Installation
pipx install tap-gmail
Configuration
Accepted Config Options
A full list of supported settings and capabilities for this tap is available by running:
tap-gmail --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-gmail
by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-gmail --version
tap-gmail --help
tap-gmail --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
pipx install poetry
poetry install
Create and Run Tests
Create tests within the tap_gmail/tests
subfolder and
then run:
poetry run pytest
You can also test the tap-gmail
CLI interface directly using poetry run
:
poetry run tap-gmail --help
Testing with Meltano
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. Open the meltano.yml
and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-gmail
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-gmail --version
# OR run a test `elt` pipeline:
meltano elt tap-gmail target-jsonl
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for meltanolabs_tap_gmail-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ce39af257303e9caae4b301cdf61bc8f8daeff26478395f16d15607e6c1f517 |
|
MD5 | b941210691ad55b1f69841bb66c38bc0 |
|
BLAKE2b-256 | 1241bd3e6e9c276a0a5e79bb6989b1246f9bca025487aa7c0fd335f55157ff69 |
Hashes for meltanolabs_tap_gmail-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31e2c724aa1dc67f3fc78a526403984943d5f27393e822e88f5969b0fef22e6c |
|
MD5 | 09f2c4b43fbb82001b1e1837477fca31 |
|
BLAKE2b-256 | f224c2cc7d1d0335eae7627b16f738af9b58072815e5ba439e7ddbff30d2ea10 |