Skip to content

Commit

Permalink
source-open-data-dc contribution from aazam-gh (#46524)
Browse files Browse the repository at this point in the history
  • Loading branch information
aazam-gh authored Oct 16, 2024
1 parent 006e006 commit 31150d1
Show file tree
Hide file tree
Showing 6 changed files with 517 additions and 0 deletions.
35 changes: 35 additions & 0 deletions airbyte-integrations/connectors/source-open-data-dc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Open Data DC
This directory contains the manifest-only connector for `source-open-data-dc`.

Open Data DC source connector which ingests data from the MAR 2 API.
The District of Columbia government uses the Master Address Repository (MAR) to implement intelligent search functionality for finding and verifying addresses, place names, blocks and intersections.
More information can be found here https://developers.data.dc.gov/

## Usage
There are multiple ways to use this connector:
- You can use this connector as any other connector in Airbyte Marketplace.
- You can load this connector in `pyairbyte` using `get_source`!
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.

Please refer to the manifest-only connector documentation for more details.

## Local Development
We recommend you use the Connector Builder to edit this connector.

But, if you want to develop this connector locally, you can use the following steps.

### Environment Setup
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).

### Build
This will create a dev image (`source-open-data-dc:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-open-data-dc build
```

### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-open-data-dc test
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-open-data-dc:dev
acceptance_tests:
spec:
tests:
- spec_path: "manifest.yaml"
connection:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
discovery:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
basic_read:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
incremental:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
full_refresh:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
18 changes: 18 additions & 0 deletions airbyte-integrations/connectors/source-open-data-dc/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 31150d1

Please sign in to comment.