Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reservoir-data/tap-streakcrm
Singer Tap for streak.com
https://github.com/reservoir-data/tap-streakcrm
crm elt gmail meltano singer-tap
Last synced: about 1 month ago
JSON representation
Singer Tap for streak.com
- Host: GitHub
- URL: https://github.com/reservoir-data/tap-streakcrm
- Owner: reservoir-data
- License: apache-2.0
- Created: 2024-04-25T05:17:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T04:29:41.000Z (about 2 months ago)
- Last Synced: 2024-12-03T05:17:42.377Z (about 2 months ago)
- Topics: crm, elt, gmail, meltano, singer-tap
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# `tap-streakcrm`
Singer tap for [Streak CRM](https://www.streak.com).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| api_key | True | None | API key in Streak |
| start_date | False | None | Earliest datetime to get data from |
Built-in Singer SDK Settings
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |
| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
| 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. |
| batch_config | False | None | |
| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
| batch_config.encoding.format | False | None | Format to use for batch files. |
| batch_config.encoding.compression | False | None | Compression format to use for batch files. |
| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
| batch_config.storage.root | False | None | Root path to use when writing batch files. |
| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
A full list of supported settings and capabilities is available by running: `tap-streakcrm --about`
## Supported Python Versions
* 3.9
* 3.10
* 3.11
* 3.12
* 3.13
### Source Authentication and Authorization
See the [documentation](https://streak.readme.io/docs/authentication).
## Usage
You can easily run `tap-streakcrm` by itself or in a pipeline using [Meltano](https://meltano.com/).
## Installation
### In a Meltano project
#### Using a direct reference
```bash
meltano add extractor tap-streakcrm --from-ref=https://raw.githubusercontent.com/reservoir-data/tap-streakcrm/main/plugin.yaml
```
Requires Meltano v3.1.0+.
#### From MeltanoHub
Not yet available.
### From PyPI
Not yet available.
### With [pipx][pipx]
```bash
pipx install git+https://github.com/reservoir-data/tap-streakcrm.git@main
```
[pipx]: https://github.com/pypa/pipx
### Executing the Tap Directly
```bash
tap-streakcrm --version
tap-streakcrm --help
tap-streakcrm --config CONFIG --discover > ./catalog.json
```
## Developer Resources
### Initialize your Development Environment
```bash
pipx install hatch
```
### Create and Run Tests
Run integration tests:
```bash
hatch run test:integration
```
You can also test the `tap-streakcrm` CLI interface directly:
```bash
hatch run sync:console -- --about --format=json
```
### 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. Go ahead and [install Meltano](https://docs.meltano.com/getting-started/installation/) if you haven't already.
1. Install all plugins
```bash
meltano install
```
1. Check that the extractor is working properly
```bash
meltano invoke tap-streakcrm --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-streakcrm 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.