## SEED Salesforce Connection
The SEED Salesforce connection enables data exchange between a SEED instance and a Salesforce instance.
### Getting Started
Clone this repository, then install the poetry-based dependencies.
```
pip install poetry
poetry install
```
### Configuring
The Salesforce configuration file is needed for this library to function correctly.
#### Salesforce
Copy `salesforce-config-example.json` to `salesforce-config-dev.json` and fill
in with the correct credentials. The format of the Salesforce should contain the following:
```
{
"instance": "https://<url>.lightning.force.com",
"username": "user@company.com",
"password": "secure-password",
"security_token": "secure-token"
"domain": ""
}
```
**IMPORTANT:** If you are connecting to a sandbox Salesforce environment, make sure to add "domain": "test" to the `salesforce-config-dev.json` file or authentication will fail.
### Running Tests
Make sure to add and configure the Salesforce configuration file. Note that it must be named `salesforce-config-dev.json` for the tests to run correctly.
Run the tests using:
```
poetry run pytest
```
#### GitHub Actions
The credentials are stored in a GitHub Action Secret. Add the following with correctly filled out information to a secret key named SALESFORCE_CONFIG:
Note that double quotes must be escaped.
```
{
\"instance\": \"https://<environment>.lightning.force.com\",
\"username\": \"user@somedomain.com\",
\"password\": \"alongpassword!asdf\",
\"security_token\": \"access1key2with3numbers\",
\"domain\": \"test\"
}
```
Raw data
{
"_id": null,
"home_page": "https://seed-platform.org",
"name": "seed-salesforce",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "SEED Platform, Building Benchmarking, Salesforce, Building Performance Standard",
"author": "Nicholas Long",
"author_email": "nicholas.long@nrel.gov",
"download_url": "https://files.pythonhosted.org/packages/f3/1d/07d98aef7aa0f5e94ad49fa7e54cad770e26602bb8207dfa9927421ef2cb/seed_salesforce-0.1.1.tar.gz",
"platform": null,
"description": "## SEED Salesforce Connection\n\nThe SEED Salesforce connection enables data exchange between a SEED instance and a Salesforce instance.\n\n### Getting Started\n\nClone this repository, then install the poetry-based dependencies.\n\n```\npip install poetry\npoetry install\n```\n\n### Configuring\n\nThe Salesforce configuration file is needed for this library to function correctly.\n\n#### Salesforce\n\nCopy `salesforce-config-example.json` to `salesforce-config-dev.json` and fill\nin with the correct credentials. The format of the Salesforce should contain the following:\n\n```\n{\n \"instance\": \"https://<url>.lightning.force.com\",\n \"username\": \"user@company.com\",\n \"password\": \"secure-password\",\n \"security_token\": \"secure-token\"\n \"domain\": \"\"\n}\n```\n\n**IMPORTANT:** If you are connecting to a sandbox Salesforce environment, make sure to add \"domain\": \"test\" to the `salesforce-config-dev.json` file or authentication will fail.\n\n### Running Tests\n\nMake sure to add and configure the Salesforce configuration file. Note that it must be named `salesforce-config-dev.json` for the tests to run correctly.\n\nRun the tests using:\n\n```\npoetry run pytest\n```\n\n#### GitHub Actions\n\nThe credentials are stored in a GitHub Action Secret. Add the following with correctly filled out information to a secret key named SALESFORCE_CONFIG:\n\nNote that double quotes must be escaped.\n\n```\n{\n \\\"instance\\\": \\\"https://<environment>.lightning.force.com\\\",\n \\\"username\\\": \\\"user@somedomain.com\\\",\n \\\"password\\\": \\\"alongpassword!asdf\\\",\n \\\"security_token\\\": \\\"access1key2with3numbers\\\",\n \\\"domain\\\": \\\"test\\\"\n}\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Package for connecting SEED data to Salesforce",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://seed-platform.org",
"Homepage": "https://seed-platform.org",
"Repository": "https://github.com/seed-platform/seed-salesforce"
},
"split_keywords": [
"seed platform",
" building benchmarking",
" salesforce",
" building performance standard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9e201e85b1891fa52e44624438d48c262264cf8792125cbe0a5f53833b5203e",
"md5": "392a5bf7fcec25354b2117e55656d0e1",
"sha256": "e8435c4a435975fc3487709499ab61fb4400c8c8466f574aaa16d5442685a92f"
},
"downloads": -1,
"filename": "seed_salesforce-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "392a5bf7fcec25354b2117e55656d0e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 7571,
"upload_time": "2024-10-09T21:37:59",
"upload_time_iso_8601": "2024-10-09T21:37:59.591071Z",
"url": "https://files.pythonhosted.org/packages/a9/e2/01e85b1891fa52e44624438d48c262264cf8792125cbe0a5f53833b5203e/seed_salesforce-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f31d07d98aef7aa0f5e94ad49fa7e54cad770e26602bb8207dfa9927421ef2cb",
"md5": "179b31786d8ef0e51ec008ab45f1523b",
"sha256": "aef31597e5319a158273ef67674dd6798fa329249e0712c0111e541e581e67c2"
},
"downloads": -1,
"filename": "seed_salesforce-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "179b31786d8ef0e51ec008ab45f1523b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 7539,
"upload_time": "2024-10-09T21:38:01",
"upload_time_iso_8601": "2024-10-09T21:38:01.068259Z",
"url": "https://files.pythonhosted.org/packages/f3/1d/07d98aef7aa0f5e94ad49fa7e54cad770e26602bb8207dfa9927421ef2cb/seed_salesforce-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 21:38:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "seed-platform",
"github_project": "seed-salesforce",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "seed-salesforce"
}
JSON
