| Name | airbyte-source-braze JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | Source implementation for Braze. |
| upload_time | 2024-01-30 14:45:43 |
| maintainer | |
| docs_url | None |
| author | Airbyte |
| requires_python | |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Braze Source
This is the repository for the Braze configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/braze).
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/braze)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_braze/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 braze test creds`
and place them into `secrets/config.json`.
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
```bash
airbyte-ci connectors --name=source-braze build
```
An image will be built with the tag `airbyte/source-braze:dev`.
**Via `docker build`:**
```bash
docker build -t airbyte/source-braze:dev .
```
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-braze:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-braze:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
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-braze test
```
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.
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
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-braze 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/braze.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": "",
"name": "airbyte-source-braze",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Airbyte",
"author_email": "contact@airbyte.io",
"download_url": "https://files.pythonhosted.org/packages/97/05/6185f7d6c9cdcc6f532a46249f70edfff060d1a5a332d4015cc02c48528d/airbyte-source-braze-0.3.0.tar.gz",
"platform": null,
"description": "# Braze Source\n\nThis is the repository for the Braze configuration based source connector.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/braze).\n\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/braze)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_braze/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 braze test creds`\nand place them into `secrets/config.json`.\n\n\n\n**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**\n```bash\nairbyte-ci connectors --name=source-braze build\n```\n\nAn image will be built with the tag `airbyte/source-braze:dev`.\n\n**Via `docker build`:**\n```bash\ndocker build -t airbyte/source-braze:dev .\n```\n\nThen run any of the connector commands as follows:\n```\ndocker run --rm airbyte/source-braze:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-braze:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-braze:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json\n```\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```bash\nairbyte-ci connectors --name=source-braze test\n```\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\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* 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\nYou've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?\n1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-braze 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/braze.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": "",
"summary": "Source implementation for Braze.",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5924d84377fbc826caaacdd4c3f50c738efa24471547fc470eb9b12aaae0117c",
"md5": "f317fc855fd538b86d2cd91d0dbd3051",
"sha256": "47c4bead5e0e166431944188f54186267ddbbd1acbf5dd4b1e67bdae56fcc1e5"
},
"downloads": -1,
"filename": "airbyte_source_braze-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f317fc855fd538b86d2cd91d0dbd3051",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20941,
"upload_time": "2024-01-30T14:45:41",
"upload_time_iso_8601": "2024-01-30T14:45:41.846108Z",
"url": "https://files.pythonhosted.org/packages/59/24/d84377fbc826caaacdd4c3f50c738efa24471547fc470eb9b12aaae0117c/airbyte_source_braze-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97056185f7d6c9cdcc6f532a46249f70edfff060d1a5a332d4015cc02c48528d",
"md5": "6832a788f733ba9cb4d59149fc9af0d5",
"sha256": "3c36e329e851bec3da28781ee1683890ed4bdadbed6981428e036473eea5d8fa"
},
"downloads": -1,
"filename": "airbyte-source-braze-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "6832a788f733ba9cb4d59149fc9af0d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12684,
"upload_time": "2024-01-30T14:45:43",
"upload_time_iso_8601": "2024-01-30T14:45:43.145042Z",
"url": "https://files.pythonhosted.org/packages/97/05/6185f7d6c9cdcc6f532a46249f70edfff060d1a5a332d4015cc02c48528d/airbyte-source-braze-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 14:45:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "airbyte-source-braze"
}
