{
    "info": {
        "author": "Stitch",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: GNU Affero General Public License v3",
            "Programming Language :: Python :: 3 :: Only"
        ],
        "description": "# pipelinewise-tap-salesforce\n\n[![PyPI version](https://badge.fury.io/py/pipelinewise-tap-salesforce.svg)](https://badge.fury.io/py/pipelinewise-tap-salesforce)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pipelinewise-tap-salesforce.svg)](https://pypi.org/project/pipelinewise-tap-salesforce/)\n[![License: MIT](https://img.shields.io/badge/License-GPLv3-yellow.svg)](https://opensource.org/licenses/GPL-3.0)\n\n[Singer](https://www.singer.io/) tap that extracts data from [Salesforce](https://www.salesforce.com/) and produces JSON-formatted output following the [Singer spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md).\n\nThis is a [PipelineWise](https://transferwise.github.io/pipelinewise) compatible tap connector.\n\n## How to use it\n\nThe recommended method of running this tap is to use it from [PipelineWise](https://transferwise.github.io/pipelinewise). When running it from PipelineWise you don't need to configure this tap with JSON files and most of things are automated. Please check the related documentation at [Tap Salesforce](https://transferwise.github.io/pipelinewise/connectors/taps/salesforce.html)\n\nIf you want to run this [Singer Tap](https://singer.io) independently please read further.\n\n### Install and Run\n\nFirst, make sure Python 3 is installed on your system or follow these\ninstallation instructions for [Mac](http://docs.python-guide.org/en/latest/starting/install3/osx/) or\n[Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04).\n\n\nIt's recommended to use a virtualenv:\n\n```bash\n  python3 -m venv venv\n  pip install pipelinewise-tap-salesforce\n```\n\nor\n\n```bash\n  python3 -m venv venv\n  . venv/bin/activate\n  pip install --upgrade pip\n  pip install .\n```\n\n### Create a Config file\n\n```\n{\n  \"client_id\": \"secret_client_id\",\n  \"client_secret\": \"secret_client_secret\",\n  \"refresh_token\": \"abc123\",\n  \"start_date\": \"2017-11-02T00:00:00Z\",\n  \"api_type\": \"BULK\",\n  \"select_fields_by_default\": true\n}\n```\n\nThe `client_id` and `client_secret` keys are your OAuth Salesforce App secrets. The `refresh_token` is a secret created during the OAuth flow. For more info on the Salesforce OAuth flow, visit the [Salesforce documentation](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.htm).\n\nThe `start_date` is used by the tap as a bound on SOQL queries when searching for records.  This should be an [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) formatted date-time, like \"2018-01-08T00:00:00Z\". For more details, see the [Singer best practices for dates](https://github.com/singer-io/getting-started/blob/master/BEST_PRACTICES.md#dates).\n\nThe `api_type` is used to switch the behavior of the tap between using Salesforce's \"REST\" and \"BULK\" APIs. When new fields are discovered in Salesforce objects, the `select_fields_by_default` key describes whether or not the tap will select those fields by default.\n\n## Run Discovery\n\nTo run discovery mode, execute the tap with the config file.\n\n```\n> tap-salesforce --config config.json --discover > properties.json\n```\n\n## Sync Data\n\nTo sync data, select fields in the `properties.json` output and run the tap.\n\n```\n> tap-salesforce --config config.json --properties properties.json [--state state.json]\n```\n\n---\n\nBased on Stitch documentation",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/transferwise/pipelinewise-tap-salesforce",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pipelinewise-tap-salesforce",
        "package_url": "https://pypi.org/project/pipelinewise-tap-salesforce/",
        "platform": "",
        "project_url": "https://pypi.org/project/pipelinewise-tap-salesforce/",
        "project_urls": {
            "Homepage": "https://github.com/transferwise/pipelinewise-tap-salesforce"
        },
        "release_url": "https://pypi.org/project/pipelinewise-tap-salesforce/1.0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Singer.io tap for extracting data from the Salesforce API - PipelineWise compatible",
        "version": "1.0.1"
    },
    "last_serial": 5688320,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e030cf53d032d48889c1c2e8b5a8ff4e",
                    "sha256": "024da5635da87c89cb25cee6aba3965b2d0703b1fb4abb30d197d5860e59fe3e"
                },
                "downloads": -1,
                "filename": "pipelinewise-tap-salesforce-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "e030cf53d032d48889c1c2e8b5a8ff4e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16270,
                "upload_time": "2019-06-25T18:42:31",
                "url": "https://files.pythonhosted.org/packages/61/8e/549104d9b58f05538b6dea90e2eba96a3b7f6ef4468dfccc124d2348ad86/pipelinewise-tap-salesforce-1.0.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b63adba521c2b67644b94b299c3d6d00",
                    "sha256": "5422adeda3952088cb725a95276933e8e89218c55455e48b1eeb6f5058a2e7b5"
                },
                "downloads": -1,
                "filename": "pipelinewise-tap-salesforce-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b63adba521c2b67644b94b299c3d6d00",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16278,
                "upload_time": "2019-08-16T15:55:33",
                "url": "https://files.pythonhosted.org/packages/0f/e9/756217510e467de2d42c5f1f1c56b800d402e5082ae2796a9a935219dd3a/pipelinewise-tap-salesforce-1.0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b63adba521c2b67644b94b299c3d6d00",
                "sha256": "5422adeda3952088cb725a95276933e8e89218c55455e48b1eeb6f5058a2e7b5"
            },
            "downloads": -1,
            "filename": "pipelinewise-tap-salesforce-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b63adba521c2b67644b94b299c3d6d00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16278,
            "upload_time": "2019-08-16T15:55:33",
            "url": "https://files.pythonhosted.org/packages/0f/e9/756217510e467de2d42c5f1f1c56b800d402e5082ae2796a9a935219dd3a/pipelinewise-tap-salesforce-1.0.1.tar.gz"
        }
    ]
}