https://github.com/hotgluexyz/tap-procore
Singer.io tap for Procore
https://github.com/hotgluexyz/tap-procore
meltano procore singer-sdk taps
Last synced: 5 months ago
JSON representation
Singer.io tap for Procore
- Host: GitHub
- URL: https://github.com/hotgluexyz/tap-procore
- Owner: hotgluexyz
- Created: 2021-04-15T17:59:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-09T15:46:41.000Z (over 4 years ago)
- Last Synced: 2023-03-04T04:13:05.847Z (over 3 years ago)
- Topics: meltano, procore, singer-sdk, taps
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tap-procore
`tap-procore` is a Singer tap for procore.
Build with the [Singer SDK](https://gitlab.com/meltano/singer-sdk).
## Installation
- [ ] `Developer TODO:` Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
```bash
pipx install tap-procore
```
## Configuration
### Accepted Config Options
- [ ] `Developer TODO:` Provide a list of config options accepted by the tap.
A full list of supported settings and capabilities for this
tap is available by running:
```bash
tap-procore --about
```
### Source Authentication and Authorization
- [ ] `Developer TODO:` If your tap requires special access on the source system, or any special authentication requirements, provide those here.
## Usage
You can easily run `tap-procore` by itself or in a pipeline using [Meltano](www.meltano.com).
### Executing the Tap Directly
```bash
tap-procore --version
tap-procore --help
tap-procore --config CONFIG --discover > ./catalog.json
```
## Developer Resources
- [ ] `Developer TODO:` As a first step, scan the entire project for the text "`TODO:`" and complete any recommended steps, deleting the "TODO" references once completed.
### Initialize your Development Environment
```bash
pipx install poetry
poetry install
```
### Create and Run Tests
Create tests within the `tap_procore/tests` subfolder and
then run:
```bash
poetry run pytest
```
You can also test the `tap-procore` CLI interface directly using `poetry run`:
```bash
poetry run tap-procore --help
```
### Testing with [Meltano](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. Open the `meltano.yml` and follow any _"TODO"_ items listed in
the file.
Next, install Meltano (if you haven't already) and any needed plugins:
```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-procore
meltano install
```
Now you can test and orchestrate using Meltano:
```bash
# Test invocation:
meltano invoke tap-procore --version
# OR run a test `elt` pipeline:
meltano etl tap-procore target-jsonl
```
### Singer SDK Dev Guide
See the [dev guide](../../docs/dev_guide.md) for more instructions on how to use the Singer SDK to
develop your own taps and targets.