Package: tap-typo
tap-typoSingertap that extracts data from theTypoplatform. The tap produces JSON-formatted data output
following theSinger spec.UsageInstallationCreate a configuration fileDiscovery modeSync modeSaving state and resumingSaving state messagesCreating a State fileResuming with a State fileCatalog fileTypo registration and setupDevelopmentSupportUsageThis section describes the basic usage oftap-typothrough an example data extraction from a Typo dataset. It assumes that you already have a Typo account, with an existing repository and a dataset. If you do not meet these prerequisites, please go toTypo Registration and Setup.InstallationPython 3 is required. It is recommended to create a separate virtual environment for each tap or target as their may be incompatibilities between dependency versions.>pipinstalltap-typoCreate a configuration fileThe config file (usually config.json) is a JSON file describing the tap's settings.The following sample configuration can be used as a starting point:{"api_key":"my_apikey","api_secret":"my_apisecret","cluster_api_endpoint":"https://cluster.typo.ai/management/api/v1","repository":"my_repository","dataset":"my_dataset","audit_id":"audit_id","output_rfc3339_datetime":false}Please note: thedatasetandaudit_idparameters are optional. When not specified the tap-typo will automatically run in sync mode using the selected datasets from the catalog.api_key,api_secretandcluster_api_endpointcan be obtained by logging into theTypo Console, clicking on your username, and then onMy Account.repositoryanddatasetcorrespond to their respective names andaudit_idis optional and should be only provided when syncing data from an audit.Additionally, arecords_per_pageparameter can be provided to override the number of records requested at once, and arecord_limitparameter can indicate the maximum number of records that will be obtained when the tap is executed.Discovery modeIn discovery mode,tap-typowill infer the Singer Catalog from the config file and data in Typo. The output can be redirected to a file in order to be modified and used as input totap-typo(seeCatalog file section).>tap-typo-cconfig.json-d>catalog.jsonSync modeSync mode will fetch data from Typo and output to stdout. Each record has two additional fields:__typo_result, that can have a value ofErrororOKand__typo_record_id, which indicates the record's internal ID in Typo. Before starting the sync, unless a custom Catalog file is provided, Typo will run discovery and build the catalog.>tap-typo-cconfig.jsonSaving state and resumingSaving state messagesWhentap-typoruns in Sync mode it will emit oneSTATE messagefor every RECORD message emitted.  STATE messages contain a value JSON property with the state information.A Singer target should output the contents of the value JSON property in a STATE message.  By redirecting this target output to a file, the value property of each STATE message will be stored per line.>tap-typo-cconfig.json|target-google-bigquery>state-history.txtCreating a State fileTo resume from a failed or terminated transfer, you will need create a STATE file from the last line in the redirected output (state-history.txt in our example).  Below is an example command that performs the step to create a STATE file, state.json, from state-history.txt.  You may edit this STATE file as necessary. The STATE file can be used as input totap-typoto resume.tail-n1state-history.txt>state.jsonExample STATE file:{"bookmarks":{"tap-typo-repository-repo1-dataset-dataset1":{"__typo_record_id":26}}}Resuming with a State fileTo resume by providing a State file,tap-typocan be started with a -s parameter and providing a path to a STATE file.tap-typosearches the bookmarks property for a key that matches the stream name.  If found,tap-typowill try to resume from the location defined in the bookmark.>tap-typo-cconfig.json-sstate.json|target-google-bigquery>state-history.txtCatalog fileA catalog file can be provided by adding the --catalog parameter with a file path. This will prevent the discovery process and use the catalog provided in the file path.>tap-typo-cconfig.json--catalogcatalog.json|target-google-bigquery>state-history.txtTypo registration and setupIn order to create a Typo account, visithttps://www.typo.ai/signupand follow the instructions.Once registered you can log in to the Typo Console (https://console.typo.ai/) and go to the Repositories section to create a new Repository.Next, you can start uploading data by usingtarget-typo. A new dataset will be created automatically when data is submitted.DevelopmentTo work on development of tap-typo, clone the repository, create and activate a new virtual environment, go into the cloned folder and install tap-typo in editable mode.gitclonehttps://github.com/typo-ai/tap-typo.gitcdtap-typo
python3-mvenv.venvsource.venv/bin/activate
pipinstall-e.SupportYou may reach Typo Support at the email address support@ followed by the typo domain or see the full contact information athttps://www.typo.ai.Copyright © 2020 Stitch