https://github.com/b-ryan/cookiecutter-singer-tap
https://github.com/b-ryan/cookiecutter-singer-tap
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/b-ryan/cookiecutter-singer-tap
- Owner: b-ryan
- Created: 2017-09-01T15:12:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-29T16:07:41.000Z (about 8 years ago)
- Last Synced: 2025-02-28T07:57:22.385Z (11 months ago)
- Language: Python
- Size: 27.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cookiecutter-singer-tap
A [cookiecutter](https://github.com/audreyr/cookiecutter) template for creating
[Singer](https://github.com/singer-io) taps.
## Usage
The best way to demonstrate creating your tap structure is with an example.
Below I will initialize the "tap-foobar" project:
```bash
$ pip install cookiecutter
$ # the next command will ask for some input:
$ cookiecutter https://github.com/b-ryan/cookiecutter-singer-tap.git
project_name [tap-zendesk-chat]: tap-foobar
package_name [tap_foobar]:
$ # For the package_name, I just hit enter since tap_foobar is what I wanted
$ cd tap-foobar
```
Now that the project exists, you can make a virtualenv and invoke the tap:
```bash
$ mkvirtualenv -p $(which python3) tap-foobar
...
$ ./setup.py develop
...
$ tap-foobar
usage: tap-foobar [-h] -c CONFIG [-s STATE] [-p PROPERTIES]
[--catalog CATALOG] [-d]
tap-foobar: error: the following arguments are required: -c/--config
```
Now you build the tap!
## Example Taps
These taps were built using this template:
- [tap-zendesk-chat](https://github.com/singer-io/tap-zendesk-chat)
- [tap-jira](https://github.com/singer-io/tap-jira)