tap-superset is a Singer tap for Superset.
Built with the Meltano Tap SDK for Singer Taps.
Install from GitHub:
pipx install git+https://github.com/ORG_NAME/tap-superset.git@mainSuperset tap class.
Built with the Meltano Singer SDK.
catalogstatediscoveraboutstream-mapsschema-flatteningbatch
| Setting | Required | Default | Description |
|---|---|---|---|
| username | True | None | Username of the db user that has access to superset api |
| password | True | None | Password |
| start_date | False | None | The earliest record date to sync |
| base_url | True | https://superset.com | The url for the API service |
| stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly). |
| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
| flattening_max_depth | False | None | The max depth to flatten schemas. |
| batch_config | False | None |
A full list of supported settings and capabilities for this tap is available by running:
tap-superset --aboutThis Singer tap will automatically import any environment variables within the working directory's
.env if the --config=ENV is provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the .env file.
tap-superset uses the /api/v1/security/# endpoint to get its Auth Token from superset.
So it is necessary to set the username and password variables for Authentication. The user provided should have access to the superset API and you can create it with the superset cli
You can easily run tap-superset by itself or in a pipeline using Meltano.
tap-superset --version
tap-superset --help
tap-superset --config CONFIG --discover > ./catalog.jsonFollow these instructions to contribute to this project.
pipx install poetry
poetry installCreate tests within the tests subfolder and
then run:
poetry run pytestYou can also test the tap-superset CLI interface directly using poetry run:
poetry run tap-superset --helpTesting with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-superset
meltano installNow you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-superset --version
# OR run a test `elt` pipeline:
meltano elt tap-superset target-jsonlSee the dev guide for more instructions on how to use the SDK to develop your own taps and targets.