# tap-salesforce-connect
`tap-salesforce-connect` is a Singer tap for Salesforce's
[Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm)
or Chatter API.
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
<!--
Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
## Installation
Install from PyPi:
```bash
pipx install tap-salesforce-connect
```
Install from GitHub:
```bash
pipx install git+https://github.com/ORG_NAME/tap-salesforce-connect.git@main
```
-->
## Configuration
### Accepted Config Options
<!--
Developer TODO: Provide a list of config options accepted by the tap.
This section can be created by copy-pasting the CLI output from:
```
tap-salesforce-connect --about --format=markdown
```
-->
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-salesforce-connect --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
<!--
Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.
-->
Retrieve your client_id, client_secret, and instance_url by following the instructions
[here](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickstart.htm).
## Usage
You can easily run `tap-salesforce-connect` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-salesforce-connect --version
tap-salesforce-connect --help
tap-salesforce-connect --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_salesforce_connect/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-salesforce-connect` CLI interface directly using `poetry run`:
```bash
poetry run tap-salesforce-connect --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._
<!--
Developer TODO:
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-salesforce-connect
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-salesforce-connect --version
# OR run a test `elt` pipeline:
meltano elt tap-salesforce-connect 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": "https://github.com/Widen/tap-salesforce-connect",
"name": "tap-salesforce-connect",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "",
"keywords": "ELT,SalesforceConnect",
"author": "Josh Lloyd",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/43/95/307f4608dac61b67c9a65f5487247b986c65ee8d605dace6814ddc274067/tap_salesforce_connect-0.1.2.tar.gz",
"platform": null,
"description": "# tap-salesforce-connect\n\n`tap-salesforce-connect` is a Singer tap for Salesforce's \n[Connect REST API](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm) \nor Chatter API.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n<!--\n\nDeveloper TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.\n\n## Installation\n\nInstall from PyPi:\n\n```bash\npipx install tap-salesforce-connect\n```\n\nInstall from GitHub:\n\n```bash\npipx install git+https://github.com/ORG_NAME/tap-salesforce-connect.git@main\n```\n\n-->\n\n## Configuration\n\n### Accepted Config Options\n\n<!--\nDeveloper TODO: Provide a list of config options accepted by the tap.\n\nThis section can be created by copy-pasting the CLI output from:\n\n```\ntap-salesforce-connect --about --format=markdown\n```\n-->\n\nA full list of supported settings and capabilities for this\ntap is available by running:\n\n```bash\ntap-salesforce-connect --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<!--\nDeveloper TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.\n-->\nRetrieve your client_id, client_secret, and instance_url by following the instructions\n[here](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickstart.htm).\n\n\n## Usage\n\nYou can easily run `tap-salesforce-connect` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-salesforce-connect --version\ntap-salesforce-connect --help\ntap-salesforce-connect --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\nFollow these instructions to contribute to this project.\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_salesforce_connect/tests` subfolder and\n then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-salesforce-connect` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-salesforce-connect --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\n<!--\nDeveloper TODO:\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-->\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-salesforce-connect\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-salesforce-connect --version\n# OR run a test `elt` pipeline:\nmeltano elt tap-salesforce-connect 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-salesforce-connect` is a Singer tap for SalesforceConnect, built with the Meltano Singer SDK.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/Widen/tap-salesforce-connect",
"Repository": "https://github.com/Widen/tap-salesforce-connect"
},
"split_keywords": [
"elt",
"salesforceconnect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "943a8148fdd81c2671b9685fac366d5aff207b8afcc38af3dc38a43bf7f3445c",
"md5": "38523e5a2552d316a6b82e3084d46b48",
"sha256": "b94c04a272238462a98af06de382651a6aa5f152ecd556ed9d66886d8058f777"
},
"downloads": -1,
"filename": "tap_salesforce_connect-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38523e5a2552d316a6b82e3084d46b48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 11945,
"upload_time": "2024-01-19T22:10:01",
"upload_time_iso_8601": "2024-01-19T22:10:01.123708Z",
"url": "https://files.pythonhosted.org/packages/94/3a/8148fdd81c2671b9685fac366d5aff207b8afcc38af3dc38a43bf7f3445c/tap_salesforce_connect-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4395307f4608dac61b67c9a65f5487247b986c65ee8d605dace6814ddc274067",
"md5": "f2dbcdd4463cd1b45f6933afda6947f1",
"sha256": "613db9e460af702a5a8157427af3a0df789f7550207a28da1f3e3d254b753767"
},
"downloads": -1,
"filename": "tap_salesforce_connect-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "f2dbcdd4463cd1b45f6933afda6947f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 11005,
"upload_time": "2024-01-19T22:10:02",
"upload_time_iso_8601": "2024-01-19T22:10:02.979521Z",
"url": "https://files.pythonhosted.org/packages/43/95/307f4608dac61b67c9a65f5487247b986c65ee8d605dace6814ddc274067/tap_salesforce_connect-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 22:10:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Widen",
"github_project": "tap-salesforce-connect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "tap-salesforce-connect"
}
JSON
