| Name | meltanolabs-tap-gmail JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | |
| Summary | `tap-gmail` is a Singer tap for Gmail, built with the Meltano SDK for Singer Taps. |
| upload_time | 2023-04-20 11:23:03 |
| maintainer | |
| docs_url | None |
| author | Ken Payne |
| requires_python | >=3.7.1,<3.12 |
| license | Apache 2.0 |
| keywords |
elt
gmail
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tap-gmail
`tap-gmail` is a Singer tap for Gmail.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Installation
```bash
pipx install tap-gmail
```
## Configuration
### Accepted Config Options
A full list of supported settings and capabilities for this
tap is available by running:
```bash
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](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-gmail --version
tap-gmail --help
tap-gmail --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_gmail/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-gmail` CLI interface directly using `poetry run`:
```bash
poetry run tap-gmail --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. 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:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-gmail
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# 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](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": "",
"name": "meltanolabs-tap-gmail",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,Gmail",
"author": "Ken Payne",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/12/41/bd3e6e9c276a0a5e79bb6989b1246f9bca025487aa7c0fd335f55157ff69/meltanolabs_tap_gmail-0.0.1.tar.gz",
"platform": null,
"description": "# tap-gmail\n\n`tap-gmail` is a Singer tap for Gmail.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n## Installation\n\n```bash\npipx install tap-gmail\n```\n\n## Configuration\n\n### Accepted Config Options\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-gmail --about\n```\n\n### Configure using environment variables\n\nThis Singer tap will automatically import any environment variables within the working directory's\n`.env` if the `--config=ENV` is provided, such that config values will be considered if a matching\nenvironment variable is set either in the terminal context or in the `.env` file.\n\n### Source Authentication and Authorization\n\n## Usage\n\nYou can easily run `tap-gmail` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-gmail --version\ntap-gmail --help\ntap-gmail --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tap_gmail/tests` subfolder and\nthen run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-gmail` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-gmail --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. Open the `meltano.yml` and follow any _\"TODO\"_ items listed in\nthe file.\n\nNext, install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n# Initialize meltano within this directory\ncd tap-gmail\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-gmail --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-gmail 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": "`tap-gmail` is a Singer tap for Gmail, built with the Meltano SDK for Singer Taps.",
"version": "0.0.1",
"split_keywords": [
"elt",
"gmail"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f224c2cc7d1d0335eae7627b16f738af9b58072815e5ba439e7ddbff30d2ea10",
"md5": "09f2c4b43fbb82001b1e1837477fca31",
"sha256": "31e2c724aa1dc67f3fc78a526403984943d5f27393e822e88f5969b0fef22e6c"
},
"downloads": -1,
"filename": "meltanolabs_tap_gmail-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09f2c4b43fbb82001b1e1837477fca31",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 8969,
"upload_time": "2023-04-20T11:23:02",
"upload_time_iso_8601": "2023-04-20T11:23:02.131134Z",
"url": "https://files.pythonhosted.org/packages/f2/24/c2cc7d1d0335eae7627b16f738af9b58072815e5ba439e7ddbff30d2ea10/meltanolabs_tap_gmail-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1241bd3e6e9c276a0a5e79bb6989b1246f9bca025487aa7c0fd335f55157ff69",
"md5": "b941210691ad55b1f69841bb66c38bc0",
"sha256": "1ce39af257303e9caae4b301cdf61bc8f8daeff26478395f16d15607e6c1f517"
},
"downloads": -1,
"filename": "meltanolabs_tap_gmail-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b941210691ad55b1f69841bb66c38bc0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 7337,
"upload_time": "2023-04-20T11:23:03",
"upload_time_iso_8601": "2023-04-20T11:23:03.829354Z",
"url": "https://files.pythonhosted.org/packages/12/41/bd3e6e9c276a0a5e79bb6989b1246f9bca025487aa7c0fd335f55157ff69/meltanolabs_tap_gmail-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 11:23:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "meltanolabs-tap-gmail"
}
