Skip to content

FosterConstructionGroup/tap-servicem8

Repository files navigation

tap-servicem8

This is a Singer tap that produces JSON-formatted data from the ServiceM8 API following the Singer spec.

This tap:

  • Pulls raw data from the ServiceM8 API
  • Extracts the following resources from ServiceM8:
    • Jobs
    • Clients
    • Categories
  • Outputs the schema for each resource
  • Incrementally pulls data based on the input state

Quick start

  1. Install

    We recommend using a virtualenv:

    > virtualenv -p python3 venv
    > source venv/bin/activate
    > pip install -e .
  2. Create the config file

    Create a JSON file called config.json containing your username and password.

    { "username": "your_username", "password": "your_password" }
  3. Run the tap in discovery mode to get properties.json file

    tap-servicem8 --config config.json --discover > properties.json
  4. In the properties.json file, select the streams to sync

    Each stream in the properties.json file has a "schema" entry. To select a stream to sync, add "selected": true to that stream's "schema" entry. For example, to sync the pull_requests stream:

    ...
    "tap_stream_id": "sites",
    "schema": {
      "selected": true,
      "properties": {
    ...
    
  5. Run the application

    tap-servicem8 can be run with:

    tap-servicem8 --config config.json --properties properties.json

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages