Name | airbyte-source-firebolt JSON |
Version |
2.0.30
JSON |
| download |
home_page | https://airbyte.com |
Summary | Source implementation for Firebolt. |
upload_time | 2025-07-26 18:20:45 |
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.
|
# Firebolt Source
This is the repository for the Firebolt source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/firebolt).
## Local development
### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**
#### Minimum Python version required `= 3.8.0`
#### Build & Activate Virtual Environment and install dependencies
From this connector directory, create a virtual environment:
```
python -m venv .venv
```
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
```
source .venv/bin/activate
pip install -r requirements.txt
```
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
should work as you expect.
#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/firebolt)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_firebolt/spec.json` file.
Note that the `secrets` directory is gitignored by default, 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 firebolt test creds`
and place them into `secrets/config.json`.
### Locally running the connector
```
python main.py spec
python main.py check --config secrets/config.json
python main.py discover --config secrets/config.json
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.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-firebolt build
```
An image will be built with the tag `airbyte/source-firebolt:dev`.
**Via `docker build`:**
```bash
docker build -t airbyte/source-firebolt:dev .
```
#### Run
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-firebolt:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-firebolt:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-firebolt:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-firebolt: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-firebolt 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-firebolt 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/firebolt.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-firebolt",
"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/ee/da/b52511d2e37c6d4d3eac9f0aadcb87cb27426f5db006f5fdfbf922a34b4d/airbyte_source_firebolt-2.0.30.tar.gz",
"platform": null,
"description": "# Firebolt Source\n\nThis is the repository for the Firebolt source connector, written in Python.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/firebolt).\n\n## Local development\n\n### Prerequisites\n\n**To iterate on this connector, make sure to complete this prerequisites section.**\n\n#### Minimum Python version required `= 3.8.0`\n\n#### Build & Activate Virtual Environment and install dependencies\n\nFrom this connector directory, create a virtual environment:\n\n```\npython -m venv .venv\n```\n\nThis will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your\ndevelopment environment of choice. To activate it from the terminal, run:\n\n```\nsource .venv/bin/activate\npip install -r requirements.txt\n```\n\nIf you are in an IDE, follow your IDE's instructions to activate the virtualenv.\n\nNote that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is\nused for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.\nIf this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything\nshould work as you expect.\n\n#### Create credentials\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/firebolt)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_firebolt/spec.json` file.\nNote that the `secrets` directory is gitignored by default, 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 firebolt test creds`\nand place them into `secrets/config.json`.\n\n### Locally running the connector\n\n```\npython main.py spec\npython main.py check --config secrets/config.json\npython main.py discover --config secrets/config.json\npython main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json\n```\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-firebolt build\n```\n\nAn image will be built with the tag `airbyte/source-firebolt:dev`.\n\n**Via `docker build`:**\n\n```bash\ndocker build -t airbyte/source-firebolt:dev .\n```\n\n#### Run\n\nThen run any of the connector commands as follows:\n\n```\ndocker run --rm airbyte/source-firebolt:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-firebolt:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-firebolt:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-firebolt: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-firebolt 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-firebolt 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/firebolt.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 Firebolt.",
"version": "2.0.30",
"project_urls": {
"Documentation": "https://docs.airbyte.com/integrations/sources/firebolt",
"Homepage": "https://airbyte.com",
"Repository": "https://github.com/airbytehq/airbyte"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "61569d307685e721be37f1ad9a79a8612208f389eaf6d826ae0c1afaeb9b60cb",
"md5": "34d3fa3603b244cbf2b66e1e4063774b",
"sha256": "aa5f84134c82c2e318f49e5b82f08f93e745d95f966b5e041d42b8f2f76ab9c6"
},
"downloads": -1,
"filename": "airbyte_source_firebolt-2.0.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34d3fa3603b244cbf2b66e1e4063774b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 10074,
"upload_time": "2025-07-26T18:20:44",
"upload_time_iso_8601": "2025-07-26T18:20:44.223804Z",
"url": "https://files.pythonhosted.org/packages/61/56/9d307685e721be37f1ad9a79a8612208f389eaf6d826ae0c1afaeb9b60cb/airbyte_source_firebolt-2.0.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eedab52511d2e37c6d4d3eac9f0aadcb87cb27426f5db006f5fdfbf922a34b4d",
"md5": "ffb8a77d3f9a8356e5dddfec2461114b",
"sha256": "3a4141ffd3192baf2b9fdb8991c3f59f8c84fd3bd52f8e3bef88f77ecfc2aa5b"
},
"downloads": -1,
"filename": "airbyte_source_firebolt-2.0.30.tar.gz",
"has_sig": false,
"md5_digest": "ffb8a77d3f9a8356e5dddfec2461114b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 7779,
"upload_time": "2025-07-26T18:20:45",
"upload_time_iso_8601": "2025-07-26T18:20:45.226055Z",
"url": "https://files.pythonhosted.org/packages/ee/da/b52511d2e37c6d4d3eac9f0aadcb87cb27426f5db006f5fdfbf922a34b4d/airbyte_source_firebolt-2.0.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-26 18:20:45",
"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-firebolt"
}