North Carolina DOT
Fetching data from North Carolina DOT with Airbyte and Python.
Description
This Airbyte Connector uses the HTTP API provided by the North Carolina DOT in Python. With this connector, data is easily pulled from North Carolina DOT and loaded into the ViaWarn Postgres database, and are available in the ViaWarn app.
The connector is built on top of the Airbyte open-source platform, which provides a standardized way of integrating data sources and destinations. It is designed to be simple and easy to use. The required configuration is show in the the sections below.
The pulled resource from the NC 511 API is the following:
- Work
Requirements and Installation
Customized files
After creating the Airbyte connector template, modify the next files to retrieve data from North Carolina DOT .
spec.yaml
In this case, the connector password is specified in the spec file.
documentationUrl: https://docsurl.com
connectionSpecification:
$schema: http://json-schema.org/draft-07/schema#
title: VIAWARN USA NC DOT - Spec
type: object
required:
- app_key
properties:
app_key:
type: string
airbyte_secret: true
description: APP Key obtained from https://datahub.transportation.gov/Roadways-and-Bridges/Work-Zone-Data-Exchange-WZDx-Feed-Registry/69qe-yiui
config.json
SECURED
config.json:
{
"app_key":"[key]"
}
configure_catalog.json
{
"streams": [
{
"stream": {
"name": "work",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
source.py
Location: source-viawarn-us-nc-dot/source.py
class ViawarnUsNcDotStream()
- url_base
This field is the common part of the URL for all streams, if it does not exist, add it in each stream method.
String
- __init__()
This is a constructor method used to initialize the class. It uses the ‘config’ object to define the ‘developer_api_key’ attribute.
return config[]
- next_page_token()
Pagination is not provided by this API.
return None
- request_params()
The API requires the ‘Developer Key’ parameter in which the data will be passed.
return a dictionary
- parse_response()
It is a placeholder to store the request.response object and constructs the appropriate mapping object for each parsed element by each Stream class.
yields an empty dictionary.
class Work()
- primary_key
Unique field required in the stream associate to each output record.
String
- path()
subdomain and parameters to pass into the URL.
return a string
- parse_response()
Definition of how a response is parsed.
Set a definition to: primary key and ewkt fields.
return an iterable containing each record in the response.
class SourceViawarnUsNcDot()
- check_connection()
Set up a test to verify the connection between the connector and the API. This test should return two variables: the first one is a boolean that indicates the status of the connection, while the second one shows a log message if the connection fails.
return True, None
- streams()
