Skip to content

Singer tap for downloading updates from the Care Quality Commission's API.

Notifications You must be signed in to change notification settings

birdiecare/tap-cqc-org-uk

Folders and files

NameName
Last commit message
Last commit date
Oct 1, 2024
Aug 20, 2024
Aug 20, 2024
Aug 20, 2024
Aug 20, 2024
Aug 20, 2024
Aug 20, 2024
Sep 20, 2021
Aug 20, 2024

Repository files navigation

tap-cqc-org-uk

tap-cqc-org-uk is a Singer tap for the Care Quality Commission's API (docs) which provides information on health and social care in England. Note this tap is still very much a work in progress.

The tap was built with the Meltano Tap SDK.

Installation

Pip

This tap isn't currently published on PyPi. You can install directly with

pipx install git+https://github.com/birdiecare/tap-cqc-org-uk.git

Meltano

Similarly this tap isn't available on the meltano hub yet. You can still install it directly with

meltano add --custom extractor tap-cqc-org-uk

And specifying git+https://github.com/birdiecare/tap-cqc-org-uk.git as the pip URL.

Streams

  • CQC_Providers: A list of health and social care provider records taken from https://api.cqc.org.uk/public/v1/providers/ docs.
  • CQC_Locations: A list of health and social care locations records taken from https://api.cqc.org.uk/public/v1/locations/ docs.

Configuration

tap-cqc-org-uk --config config_example.json

where config_example.json is

{
  "start_date": "2021-10-27T00:00:00Z",
  "subscription_key": "?? your CQC subscription key ??"
}
  • start_date: the date from which changes will be downloaded. Note that if a record was created before this date and not updated after it then it will not be downloaded by the tap.
  • subscription_key: Primary key from in CQC developer portal https://api-portal.service.cqc.org.uk/profile.

Usage

You can run tap-cqc-org-uk by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-cqc-org-uk --version
tap-cqc-org-uk --help
tap-cqc-org-uk --config CONFIG --discover > ./catalog.json

About

Singer tap for downloading updates from the Care Quality Commission's API.

Resources

Stars

Watchers

Forks

Releases

No releases published