<div align="center">
# tap-getcensus
<div>
<a href="https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-getcensus/main">
<img alt="pre-commit.ci status" src="https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-getcensus/main.svg"/>
</a>
<a href="https://github.com/edgarrmondragon/tap-getcensus/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/edgarrmondragon/tap-getcensus"/>
</a>
</div>
Singer Tap for the [Census Operational Analytics Platform](https://www.getcensus.com/). Built with the [Meltano Singer SDK](https://sdk.meltano.com).
</div>
## 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` | 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](https://docs.getcensus.com/basics/api#getting-api-access).
## Usage
You can easily run `tap-getcensus` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-getcensus --version
tap-getcensus --help
tap-getcensus --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tests` subfolder and then run:
```bash
poetry run pytest
```
You can also test the `tap-getcensus` CLI interface directly using `poetry run`:
```bash
poetry run tap-getcensus --help
```
### Testing with [Meltano](https://www.meltano.com)
_**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:
```bash
# 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:
```bash
# Test invocation:
meltano invoke tap-getcensus --version
# OR run a pipeline:
meltano run tap-getcensus target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.
Raw data
{
"_id": null,
"home_page": "https://github.com/edgarrmondragon/tap-getcensus",
"name": "tap-getcensus",
"maintainer": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"docs_url": null,
"requires_python": ">=3.7.1,<3.12",
"maintainer_email": "edgarrm358@gmail.com",
"keywords": "ELT,singer.io,Census",
"author": "Edgar Ram\u00edrez-Mondrag\u00f3n",
"author_email": "edgarrm358@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c5/3f/25720c11a74b39364b588690dfb5725edfd73567570be4c728854d604d19/tap_getcensus-0.0.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# tap-getcensus\n\n<div>\n <a href=\"https://results.pre-commit.ci/latest/github/edgarrmondragon/tap-getcensus/main\">\n <img alt=\"pre-commit.ci status\" src=\"https://results.pre-commit.ci/badge/github/edgarrmondragon/tap-getcensus/main.svg\"/>\n </a>\n <a href=\"https://github.com/edgarrmondragon/tap-getcensus/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/edgarrmondragon/tap-getcensus\"/>\n </a>\n</div>\n\nSinger Tap for the [Census Operational Analytics Platform](https://www.getcensus.com/). Built with the [Meltano Singer SDK](https://sdk.meltano.com).\n\n</div>\n\n## Capabilities\n\n* `catalog`\n* `state`\n* `discover`\n* `about`\n* `stream-maps`\n* `schema-flattening`\n\n## Settings\n\n| Setting | Required | Default | Description |\n|:--------------------|:--------:|:-------:|:------------|\n| api_token | True | None | Auth token for getcensus.com API |\n| stream_maps | False | None | Config object for stream maps capability. |\n| stream_map_config | False | None | User-defined config values to be used within map expressions. |\n| flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |\n| flattening_max_depth| False | None | The max depth to flatten schemas. |\n\nA full list of supported settings and capabilities is available by running: `tap-getcensus --about`\n\n## Streams\n\n| Stream | Replication Method | Replication Key | Primary Key | Documentation |\n|:----------------------|:------------------:|:---------------:|:-----------:|:-------------:|\n| `syncs` | Full Table | None | id | https://docs.getcensus.com/basics/api/syncs#get-syncs |\n| `sync_runs` | Full Table | None | id | https://docs.getcensus.com/basics/api/sync-runs#get-syncs-id-sync_runs |\n| `destinations` | Full Table | None | id | https://docs.getcensus.com/basics/api/destinations#get-destinations |\n| `destination_objects` | Full Table | None | id | https://docs.getcensus.com/basics/api/destination-objects#get-destinations-id-objects |\n| `sources` | Full Table | None | id | https://docs.getcensus.com/basics/api/sources#get-sources |\n| `source_objects` | Full Table | None | id | https://docs.getcensus.com/basics/api/source-objects#get-sources-id-objects |\n\nThe full catalog is available by running: `tap-getcensus --discover`\n\n### Source Authentication and Authorization\n\nSee the [API docs](https://docs.getcensus.com/basics/api#getting-api-access).\n\n## Usage\n\nYou can easily run `tap-getcensus` by itself or in a pipeline using [Meltano](https://meltano.com/).\n\n### Executing the Tap Directly\n\n```bash\ntap-getcensus --version\ntap-getcensus --help\ntap-getcensus --config CONFIG --discover > ./catalog.json\n```\n\n## Developer Resources\n\n### Initialize your Development Environment\n\n```bash\npipx install poetry\npoetry install\n```\n\n### Create and Run Tests\n\nCreate tests within the `tests` subfolder and then run:\n\n```bash\npoetry run pytest\n```\n\nYou can also test the `tap-getcensus` CLI interface directly using `poetry run`:\n\n```bash\npoetry run tap-getcensus --help\n```\n\n### Testing with [Meltano](https://www.meltano.com)\n\n_**Note:** This tap will work in any Singer environment and does not require Meltano.\nExamples here are for convenience and to streamline end-to-end orchestration scenarios._\n\nYour project comes with a custom `meltano.yml` project file already created. Install Meltano (if you haven't already) and any needed plugins:\n\n```bash\n# Install meltano\npipx install meltano\n\n# Update all plugin definitions\nmeltano lock --update --all\n\n# Initialize meltano within this directory\ncd tap-getcensus\nmeltano install\n```\n\nNow you can test and orchestrate using Meltano:\n\n```bash\n# Test invocation:\nmeltano invoke tap-getcensus --version\n\n# OR run a pipeline:\nmeltano run tap-getcensus target-jsonl\n```\n\n### SDK Dev Guide\n\nSee the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to\ndevelop your own taps and targets.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Singer tap for the Census Operational Analytics Platform, built with the Meltano SDK for Singer Taps.",
"version": "0.0.2",
"split_keywords": [
"elt",
"singer.io",
"census"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fd05f95f5810b3584334db5c5fc6ba87528e7f137f62b9f2ae3c384567d83a31",
"md5": "71346329482a1a925e8f1c1c96edc56c",
"sha256": "c1f2ab4136cdd07b8a3f883746803d64882d4de645d894146ad61dc907fae11b"
},
"downloads": -1,
"filename": "tap_getcensus-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "71346329482a1a925e8f1c1c96edc56c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<3.12",
"size": 7476,
"upload_time": "2023-04-11T06:16:44",
"upload_time_iso_8601": "2023-04-11T06:16:44.914167Z",
"url": "https://files.pythonhosted.org/packages/fd/05/f95f5810b3584334db5c5fc6ba87528e7f137f62b9f2ae3c384567d83a31/tap_getcensus-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c53f25720c11a74b39364b588690dfb5725edfd73567570be4c728854d604d19",
"md5": "4ecac87cc6e5deb8444eebec041c269d",
"sha256": "cf76321fda28fa0cf8f0f6c52609710ef93a9185722cc678e245ff719462b421"
},
"downloads": -1,
"filename": "tap_getcensus-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "4ecac87cc6e5deb8444eebec041c269d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<3.12",
"size": 7800,
"upload_time": "2023-04-11T06:16:46",
"upload_time_iso_8601": "2023-04-11T06:16:46.966819Z",
"url": "https://files.pythonhosted.org/packages/c5/3f/25720c11a74b39364b588690dfb5725edfd73567570be4c728854d604d19/tap_getcensus-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-11 06:16:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "edgarrmondragon",
"github_project": "tap-getcensus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "tap-getcensus"
}
JSON
