Source implementation for Senseforce.
Project description
Senseforce source connector
This is the repository for the Senseforce source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.
Local development
Prerequisites
- Python (~=3.9)
- Poetry (~=1.7) - installation instructions here
Installing the connector
From this connector directory, run:
poetry install --with dev
Create credentials
If you are a community contributor, follow the instructions in the documentation
to generate the necessary credentials. Then create a file secrets/config.json
conforming to the source_senseforce/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.
Locally running the connector
poetry run source-senseforce spec
poetry run source-senseforce check --config secrets/config.json
poetry run source-senseforce discover --config secrets/config.json
poetry run source-senseforce 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
- Install
airbyte-ci
- Run the following command to build the docker image:
airbyte-ci connectors --name=source-senseforce build
An image will be available on your host with the tag airbyte/source-senseforce:dev
.
Running as a docker container
Then run any of the connector commands as follows:
docker run --rm airbyte/source-senseforce:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-senseforce:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-senseforce:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-senseforce: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
:
airbyte-ci connectors --name=source-senseforce test
Customizing acceptance Tests
Customize acceptance-test-config.yml
file to configure acceptance tests. See Connector Acceptance Tests 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:
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?
- Make sure your changes are passing our test suite:
airbyte-ci connectors --name=source-senseforce test
- Bump the connector version (please follow semantic versioning for connectors):
- bump the
dockerImageTag
value in inmetadata.yaml
- bump the
version
value inpyproject.toml
- bump the
- Make sure the
metadata.yaml
content is up to date. - Make sure the connector documentation and its changelog is up to date (
docs/integrations/sources/senseforce.md
). - Create a Pull Request: use our PR naming conventions.
- Pat yourself on the back for being an awesome contributor.
- Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
- Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for airbyte_source_senseforce-0.1.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff0811cea9bece2b40b1a6cad6591f1fb8804e79b0e01ab3f3c7041f6ed9b30b |
|
MD5 | 8b17954d0b901c702f9a52593270beb0 |
|
BLAKE2b-256 | 7e6dc949198a5279b1fcf6400b30b22ba83c52f99169302b80fb5dcff279b813 |
Hashes for airbyte_source_senseforce-0.1.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03343d86c528cb4cb78e9635148812c44b66c2f10ac6b43dcea04e2f19b3ff95 |
|
MD5 | 9ab37a5747586e43a92abc1babd791ee |
|
BLAKE2b-256 | 2676a40bdef47ec54f2b1e2633efe58b6fbb6d8a26c29d751c716ce94128a452 |