tap-getcensus
Singer Tap for the Census Operational Analytics Platform. Built with the Meltano Singer SDK.
Capabilities
catalogstatediscoveraboutstream-mapsschema-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 |
Full Table | None | id | https://docs.getcensus.com/basics/api/syncs#get-syncs |
sync_runs |
Full Table | None | 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
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. Install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Update all plugin definitions
meltano lock --update --all
# 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 pipeline:
meltano run 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.
Metadata
Release files for tap-getcensus 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tap_getcensus-0.0.2.tar.gz | 7.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tap_getcensus-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.3 kB
Release files / tap_getcensus-0.0.2.tar.gz
| Download URL | tap_getcensus-0.0.2.tar.gz |
|---|---|
| Size | 7.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf76321fda28fa0cf8f0f6c52609710ef93a9185722cc678e245ff719462b421
|
|
BLAKE2b-256 checksum How to use checksums |
c53f25720c11a74b39364b588690dfb5725edfd73567570be4c728854d604d19
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.1 CPython/3.11.3
|
Release files / tap_getcensus-0.0.2-py3-none-any.whl
| Download URL | tap_getcensus-0.0.2-py3-none-any.whl |
|---|---|
| Size | 7.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c1f2ab4136cdd07b8a3f883746803d64882d4de645d894146ad61dc907fae11b
|
|
BLAKE2b-256 checksum How to use checksums |
fd05f95f5810b3584334db5c5fc6ba87528e7f137f62b9f2ae3c384567d83a31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.1 CPython/3.11.3
|