From 1a72a3ef90853f542053d3fdefa7d3030a45417a Mon Sep 17 00:00:00 2001 From: vitaliizazmic <75620293+vitaliizazmic@users.noreply.github.com> Date: Tue, 26 Jan 2021 04:56:43 +0200 Subject: [PATCH] Tempo source #1616 - fixing README.md in source-tempo, creating tempo.md in docs (#1819) --- .../connectors/source-tempo/README.md | 30 +++++++------- docs/integrations/sources/tempo.md | 41 +++++++++++++++++++ 2 files changed, 56 insertions(+), 15 deletions(-) create mode 100644 docs/integrations/sources/tempo.md diff --git a/airbyte-integrations/connectors/source-tempo/README.md b/airbyte-integrations/connectors/source-tempo/README.md index 10a3817d90fbf..9cf3e067deb5f 100644 --- a/airbyte-integrations/connectors/source-tempo/README.md +++ b/airbyte-integrations/connectors/source-tempo/README.md @@ -1,7 +1,7 @@ -# Jira Source +# Tempo Source -This is the repository for the Jira source connector, written in Python. -For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/jira). +This is the repository for the Tempo source connector, written in Python. +For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/tempo). ## Local development @@ -11,23 +11,23 @@ For information about how to use this connector within Airbyte, see [the documen #### Build & Activate Virtual Environment First, build the module by running the following from the `airbyte` project root directory: ``` -./gradlew :airbyte-integrations:connectors:source-jira:build +./gradlew :airbyte-integrations:connectors:source-tempo:build ``` -This will generate a virtualenv for this module in `source-jira/.venv`. Make sure this venv is active in your +This will generate a virtualenv for this module in `source-tempo/.venv`. Make sure this venv is active in your development environment of choice. To activate the venv from the terminal, run: ``` -cd airbyte-integrations/connectors/source-jira # cd into the connector directory +cd airbyte-integrations/connectors/source-tempo # cd into the connector directory source .venv/bin/activate ``` If you are in an IDE, follow your IDE's instructions to activate the virtualenv. #### Create credentials -**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/jira) -to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_jira/spec.json` file. +**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/tempo) +to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_tempo/spec.json` file. See `sample_files/sample_config.json` for a sample config file. -**If you are an Airbyte core member**, copy the credentials in RPass under the secret name `source-jira-integration-test-config` +**If you are an Airbyte core member**, copy the credentials in RPass under the secret name `source-tempo-integration-test-config` and place them into `secrets/config.json`. @@ -48,15 +48,15 @@ pytest unit_tests ### Locally running the connector docker image ``` # in airbyte root directory -./gradlew :airbyte-integrations:connectors:source-jira:airbyteDocker -docker run --rm airbyte/source-jira:dev spec -docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-jira/secrets:/secrets airbyte/source-jira:dev check --config /secrets/config.json -docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-jira/secrets:/secrets airbyte/source-jira:dev discover --config /secrets/config.json -docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-jira/secrets:/secrets -v $(pwd)/airbyte-integrations/connectors/source-jira/sample_files:/sample_files airbyte/source-jira:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json +./gradlew :airbyte-integrations:connectors:source-tempo:airbyteDocker +docker run --rm airbyte/source-tempo:dev spec +docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-tempo/secrets:/secrets airbyte/source-tempo:dev check --config /secrets/config.json +docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-tempo/secrets:/secrets airbyte/source-tempo:dev discover --config /secrets/config.json +docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-tempo/secrets:/secrets -v $(pwd)/airbyte-integrations/connectors/source-tempo/sample_files:/sample_files airbyte/source-tempo:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json ``` ### Integration Tests -1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-jira:standardSourceTestPython` to run the standard integration test suite. +1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-tempo:standardSourceTestPython` to run the standard integration test suite. 1. To run additional integration tests, place your integration tests in the `integration_tests` directory and run them with `pytest integration_tests`. Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named. diff --git a/docs/integrations/sources/tempo.md b/docs/integrations/sources/tempo.md new file mode 100644 index 0000000000000..797f895d07fae --- /dev/null +++ b/docs/integrations/sources/tempo.md @@ -0,0 +1,41 @@ +# Tempo + +## Overview + +This Source uses the [REST API version 3](https://tempo-io.github.io/tempo-api-docs/) to sync Tempo data. + +### Output schema + +This connector outputs the following streams: + +* Accounts +* Customers +* Worklogs +* Workload Schemes + + +### Features + +| Feature | Supported? | +| :--- | :--- | +| Full Refresh Sync | Yes | +| Incremental - Append Sync | No | +| Replicate Incremental Deletes | Coming soon | +| SSL connection | Yes | + +If there are more endpoints you'd like Airbyte to support, please [create an issue.](https://github.com/airbytehq/airbyte/issues/new/choose) + +## Getting started + +### Requirements + +* API Token + +### Setup guide + +Source Tempo is designed to interact with the data your permissions give you access to. To do so, you will need to generate a Tempo OAuth 2.0 token for an individual user. + +Go to **Tempo > Settings**, scroll down to **Data Access** and select **API integration**. + + +