# Gainsight Px Source
This is the repository for the Gainsight Px configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/gainsight-px).
## Local development
#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/gainsight-px)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_gainsight_px/spec.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `integration_tests/sample_config.json` for a sample config file.
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source gainsight-px test creds`
and place them into `secrets/config.json`.
### Locally running the connector docker image
#### Build
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
```bash
airbyte-ci connectors --name=source-gainsight-px build
```
An image will be built with the tag `airbyte/source-gainsight-px:dev`.
**Via `docker build`:**
```bash
docker build -t airbyte/source-gainsight-px:dev .
```
#### Run
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-gainsight-px:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gainsight-px:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gainsight-px:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-gainsight-px:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
```bash
airbyte-ci connectors --name=source-gainsight-px test
```
### Customizing acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
## Dependency Management
All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
We split dependencies between two groups, dependencies that are:
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
### Publishing a new version of the connector
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-gainsight-px test`
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
3. Make sure the `metadata.yaml` content is up to date.
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/gainsight-px.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
Raw data
{
"_id": null,
"home_page": "https://airbyte.com",
"name": "airbyte-source-gainsight-px",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Airbyte",
"author_email": "contact@airbyte.io",
"download_url": "https://files.pythonhosted.org/packages/45/85/38c64a21b4bdf46c2e37daf152039d686b6edb230d9f8a57ddd76c9bed78/airbyte_source_gainsight_px-0.1.14.tar.gz",
"platform": null,
"description": "# Gainsight Px Source\n\nThis is the repository for the Gainsight Px configuration based source connector.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/gainsight-px).\n\n## Local development\n\n#### Create credentials\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/gainsight-px)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_gainsight_px/spec.yaml` file.\nNote that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.\nSee `integration_tests/sample_config.json` for a sample config file.\n\n**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source gainsight-px test creds`\nand place them into `secrets/config.json`.\n\n### Locally running the connector docker image\n\n#### Build\n\n**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**\n\n```bash\nairbyte-ci connectors --name=source-gainsight-px build\n```\n\nAn image will be built with the tag `airbyte/source-gainsight-px:dev`.\n\n**Via `docker build`:**\n\n```bash\ndocker build -t airbyte/source-gainsight-px:dev .\n```\n\n#### Run\n\nThen run any of the connector commands as follows:\n\n```\ndocker run --rm airbyte/source-gainsight-px:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gainsight-px:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-gainsight-px:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-gainsight-px:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json\n```\n\n## Testing\n\nYou can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):\n\n```bash\nairbyte-ci connectors --name=source-gainsight-px test\n```\n\n### Customizing acceptance Tests\n\nCustomize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.\nIf your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.\n\n## Dependency Management\n\nAll of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.\nWe split dependencies between two groups, dependencies that are:\n\n- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.\n- required for the testing need to go to `TEST_REQUIREMENTS` list\n\n### Publishing a new version of the connector\n\nYou've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?\n\n1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-gainsight-px test`\n2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).\n3. Make sure the `metadata.yaml` content is up to date.\n4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/gainsight-px.md`).\n5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).\n6. Pat yourself on the back for being an awesome contributor.\n7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Source implementation for Gainsight Px.",
"version": "0.1.14",
"project_urls": {
"Documentation": "https://docs.airbyte.com/integrations/sources/gainsight-px",
"Homepage": "https://airbyte.com",
"Repository": "https://github.com/airbytehq/airbyte"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4dea0936f9917d6f733e313244ee3ebca20532319970926757289510edd0be4c",
"md5": "301edb0d34a85c7f3f752da083da44e5",
"sha256": "4ee5e57fc60df44f90a98f0126e6c95ad875ff5a3bdf9bbeb0a44efd067149df"
},
"downloads": -1,
"filename": "airbyte_source_gainsight_px-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "301edb0d34a85c7f3f752da083da44e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 6504,
"upload_time": "2024-08-18T01:22:26",
"upload_time_iso_8601": "2024-08-18T01:22:26.672052Z",
"url": "https://files.pythonhosted.org/packages/4d/ea/0936f9917d6f733e313244ee3ebca20532319970926757289510edd0be4c/airbyte_source_gainsight_px-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "458538c64a21b4bdf46c2e37daf152039d686b6edb230d9f8a57ddd76c9bed78",
"md5": "a6f454780e77217831f9778dc835a02d",
"sha256": "54523087c4cf90bdc94e5a0f0c7c59d5ee2142102e1502ffc065ff8405accc94"
},
"downloads": -1,
"filename": "airbyte_source_gainsight_px-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "a6f454780e77217831f9778dc835a02d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 6520,
"upload_time": "2024-08-18T01:22:27",
"upload_time_iso_8601": "2024-08-18T01:22:27.563016Z",
"url": "https://files.pythonhosted.org/packages/45/85/38c64a21b4bdf46c2e37daf152039d686b6edb230d9f8a57ddd76c9bed78/airbyte_source_gainsight_px-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 01:22:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "airbytehq",
"github_project": "airbyte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "airbyte-source-gainsight-px"
}
JSON
