Singer tap for the Census Operational Analytics Platform, built with the Meltano SDK for Singer Taps.
Project description
tap-getcensus
Singer Tap for the Census Operational Analytics Platform. Built with the Meltano Singer SDK.
Capabilities
catalog
state
discover
about
stream-maps
schema-flattening
Settings
Setting | Required | Default | Description |
---|---|---|---|
api_token | True | None | Auth token for getcensus.com API |
stream_maps | False | None | Config object for stream maps capability. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
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. |
A full list of supported settings and capabilities is available by running: tap-getcensus --about
Streams
Stream | Replication Method | Replication Key | Primary Key | Documentation |
---|---|---|---|---|
syncs |
Incremental | updated_at | id | https://docs.getcensus.com/basics/api/syncs#get-syncs |
sync_runs |
Incremental | updated_at | id | https://docs.getcensus.com/basics/api/sync-runs#get-syncs-id-sync_runs |
destinations |
Full Table | None | id | https://docs.getcensus.com/basics/api/destinations#get-destinations |
destination_objects |
Full Table | None | id | https://docs.getcensus.com/basics/api/destination-objects#get-destinations-id-objects |
sources |
Full Table | None | id | https://docs.getcensus.com/basics/api/sources#get-sources |
source_objects |
Full Table | None | id | https://docs.getcensus.com/basics/api/source-objects#get-sources-id-objects |
The full catalog is available by running: tap-getcensus --discover
Source Authentication and Authorization
See the API docs.
Usage
You can easily run tap-getcensus
by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-getcensus --version
tap-getcensus --help
tap-getcensus --config CONFIG --discover > ./catalog.json
Developer Resources
-
Developer TODO:
As a first step, scan the entire project for the text "TODO:
" and complete any recommended steps, deleting the "TODO" references once completed.
Initialize your Development Environment
pipx install poetry
poetry install
Create and Run Tests
Create tests within the tests
subfolder and then run:
poetry run pytest
You can also test the tap-getcensus
CLI interface directly using poetry run
:
poetry run tap-getcensus --help
Testing 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.
Your project comes with a custom meltano.yml
project file already created. Open the meltano.yml
and follow any "TODO" items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-getcensus
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-getcensus --version
# OR run a test `elt` pipeline:
meltano elt tap-getcensus target-jsonl
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_getcensus-0.0.1b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f67e1ae8f2b81f73ba82317117b2b76ddf57dbe56092b68a7325caee74ce7227 |
|
MD5 | fd897a251e91646f56e43fe4a4922893 |
|
BLAKE2b-256 | eda383ff22c63c83db00c3970cd836e85013558a35177168cc463a41aa76ad0a |