Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/envoy/tap-chargebee
Singer.io tap for extracting data from the Chargebee API
https://github.com/envoy/tap-chargebee
etl singer singer-tap
Last synced: about 2 months ago
JSON representation
Singer.io tap for extracting data from the Chargebee API
- Host: GitHub
- URL: https://github.com/envoy/tap-chargebee
- Owner: envoy
- License: agpl-3.0
- Created: 2019-03-19T19:00:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T19:40:43.000Z (8 months ago)
- Last Synced: 2024-05-03T05:20:40.234Z (8 months ago)
- Topics: etl, singer, singer-tap
- Language: Python
- Homepage: https://www.singer.io/
- Size: 160 KB
- Stars: 2
- Watchers: 6
- Forks: 48
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tap-chargebee
This is a [Singer](https://singer.io) tap that produces JSON-formatted data
following the [Singer
spec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).
This tap:
- Pulls raw data from the [Chargebee API](https://apidocs.chargebee.com/docs/api)
- Extracts the following resources:
- [Addons](https://apidocs.chargebee.com/docs/api/addons)
- [Coupons](https://apidocs.chargebee.com/docs/api/coupons)
- [Credit Notes](https://apidocs.chargebee.com/docs/api/credit_notes)
- [Customers](https://apidocs.chargebee.com/docs/api/customers)
- [Events](https://apidocs.chargebee.com/docs/api/events)
- [Invoices](https://apidocs.chargebee.com/docs/api/invoices)
- [Payment Sources](https://apidocs.chargebee.com/docs/api/payment_sources)
- [Plans](https://apidocs.chargebee.com/docs/api/plans)
- [Subscriptions](https://apidocs.chargebee.com/docs/api/subscriptions)
- [Transactions](https://apidocs.chargebee.com/docs/api/transactions)
- [Virtual Bank Accounts](https://apidocs.chargebee.com/docs/api/virtual_bank_accounts)
- Outputs the schema for each resource
- Incrementally pulls data based on the input state
## Quick Start
1. Install
```bash
pip install tap-chargebee
```
2. Create the config file
Create a JSON file called `config.json`. Its contents should look like:
```json
{
"start_date": "2010-01-01",
"api_key": "",
"site": ""
}
```
The `start_date` specifies the date at which the tap will begin pulling data
(for those resources that support this).
The `api_key` is the API key for your Chargebee site.
The `site` parameter represents the name of your specific Chargebee site (e.g. `https://{site}.chargebee.com/api/v2/subscriptions`)
4. Run the Tap in Discovery Mode
```bash
tap-chargebee --config config.json --discover > catalog.json
```
See the Singer docs on discovery mode
[here](https://github.com/singer-io/getting-started/blob/master/docs/DISCOVERY_MODE.md#discovery-mode).
5. Run the Tap in Sync Mode
```bash
tap-chargebee --config config.json --catalog catalog.json
```
---
Copyright © 2019 Stitch