| Name | airbyte-source-onesignal JSON |
| Version |
1.1.14
JSON |
| download |
| home_page | https://airbyte.com |
| Summary | Source implementation for One Signal. |
| upload_time | 2024-09-29 00:36:05 |
| maintainer | None |
| docs_url | None |
| author | Airbyte |
| requires_python | <3.12,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Onesignal Source
This is the repository for the Onesignal configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/onesignal).
## Local development
### Prerequisites
- Python (~=3.9)
- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
### Installing the connector
From this connector directory, run:
```bash
poetry install --with dev
```
### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/onesignal)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_onesignal/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 `sample_files/sample_config.json` for a sample config file.
### Locally running the connector
```
poetry run source-onesignal spec
poetry run source-onesignal check --config secrets/config.json
poetry run source-onesignal discover --config secrets/config.json
poetry run source-onesignal read --config secrets/config.json --catalog integration_tests/configured_catalog.json
```
### Running unit tests
To run unit tests locally, from the connector directory run:
```
poetry run pytest unit_tests
```
### Building the docker image
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:
```bash
airbyte-ci connectors --name=source-onesignal build
```
An image will be available on your host with the tag `airbyte/source-onesignal:dev`.
### Running as a docker container
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-onesignal:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-onesignal:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-onesignal:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-onesignal:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
### Running our CI test suite
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-onesignal test
```
### Customizing acceptance Tests
Customize `acceptance-test-config.yml` file to configure acceptance 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 be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
### 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-onesignal 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/onesignal.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-onesignal",
"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/52/2d/65b5c52f9394a56215f27c9049a1c98b4364dd5b6ffde633b231c33560c1/airbyte_source_onesignal-1.1.14.tar.gz",
"platform": null,
"description": "# Onesignal Source\n\nThis is the repository for the Onesignal configuration based source connector.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/onesignal).\n\n## Local development\n\n### Prerequisites\n\n- Python (~=3.9)\n- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)\n\n### Installing the connector\n\nFrom this connector directory, run:\n\n```bash\npoetry install --with dev\n```\n\n### Create credentials\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/onesignal)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_onesignal/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 `sample_files/sample_config.json` for a sample config file.\n\n### Locally running the connector\n\n```\npoetry run source-onesignal spec\npoetry run source-onesignal check --config secrets/config.json\npoetry run source-onesignal discover --config secrets/config.json\npoetry run source-onesignal read --config secrets/config.json --catalog integration_tests/configured_catalog.json\n```\n\n### Running unit tests\n\nTo run unit tests locally, from the connector directory run:\n\n```\npoetry run pytest unit_tests\n```\n\n### Building the docker image\n\n1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)\n2. Run the following command to build the docker image:\n\n```bash\nairbyte-ci connectors --name=source-onesignal build\n```\n\nAn image will be available on your host with the tag `airbyte/source-onesignal:dev`.\n\n### Running as a docker container\n\nThen run any of the connector commands as follows:\n\n```\ndocker run --rm airbyte/source-onesignal:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-onesignal:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-onesignal:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-onesignal:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json\n```\n\n### Running our CI test suite\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-onesignal test\n```\n\n### Customizing acceptance Tests\n\nCustomize `acceptance-test-config.yml` file to configure acceptance 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 be managed via Poetry.\nTo add a new dependency, run:\n\n```bash\npoetry add <package-name>\n```\n\nPlease commit the changes to `pyproject.toml` and `poetry.lock` files.\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-onesignal 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/onesignal.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 One Signal.",
"version": "1.1.14",
"project_urls": {
"Documentation": "https://docs.airbyte.com/integrations/sources/source-onesignal",
"Homepage": "https://airbyte.com",
"Repository": "https://github.com/airbytehq/airbyte"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd179fdc65553d73bc2d9baac57018a24f2c1011b7991c1891eb5d84a41e989b",
"md5": "2783b40c4a1870c42e37c56ce6035015",
"sha256": "819c20ac32358115a9707f5b2f790d34295983de1f0d8e5e892a23966cbd5661"
},
"downloads": -1,
"filename": "airbyte_source_onesignal-1.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2783b40c4a1870c42e37c56ce6035015",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 8859,
"upload_time": "2024-09-29T00:36:04",
"upload_time_iso_8601": "2024-09-29T00:36:04.075571Z",
"url": "https://files.pythonhosted.org/packages/fd/17/9fdc65553d73bc2d9baac57018a24f2c1011b7991c1891eb5d84a41e989b/airbyte_source_onesignal-1.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "522d65b5c52f9394a56215f27c9049a1c98b4364dd5b6ffde633b231c33560c1",
"md5": "7abc667b81b8a25fe3da0d99eb2beb64",
"sha256": "db6f399bcf499e05e19f382bea28c5e73d463c60fae79a2be4d1e069d0e2fe40"
},
"downloads": -1,
"filename": "airbyte_source_onesignal-1.1.14.tar.gz",
"has_sig": false,
"md5_digest": "7abc667b81b8a25fe3da0d99eb2beb64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 7623,
"upload_time": "2024-09-29T00:36:05",
"upload_time_iso_8601": "2024-09-29T00:36:05.344345Z",
"url": "https://files.pythonhosted.org/packages/52/2d/65b5c52f9394a56215f27c9049a1c98b4364dd5b6ffde633b231c33560c1/airbyte_source_onesignal-1.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-29 00:36:05",
"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-onesignal"
}
