Giter VIP home page Giter VIP logo

tap-confluence's Introduction

tap-confluence

Super-Linter

Singer tap for the Confluence REST API. Developed using the Singer SDK.

Installation

pipx install git+https://github.com/edgarrmondragon/tap-confluence.git

Roadmap

  • Content
  • Spaces
  • Themes
  • Groups
  • Users

Configuration

{
    "base_url": "https://your-domain.atlassian.net/wiki/rest/api",
    "email": "<[email protected]>",
    "api_token": "<your_user_api_token>",
    "user_agent": "MyDataIntegrationApp/1.0.0 Singer.io Tap for Confluence"
}

Developer Resources

Initialize your Development Environment

You will need Poetry installed on your machine.

# Install package dependencies
poetry install

# Extract records
poetry run tap-confluence --config config.json

Links

tap-confluence's People

Contributors

dependabot[bot] avatar edgarrmondragon avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

tap-confluence's Issues

Streams for each content type

The /content/ (/wiki/rest/api/content in the API docs) can return pages and blogposts. By default it return pages. There should be one stream for each content type.

Readme and poetry

Hey

This tap currently linked to from the docs, it would be useful to include some details on poetry, as that is probably new to a great deal of those ending up at this repo :D

  1. Install poetry
  2. Run the tap
poetry --version
poetry run tap-confluence --config config.json

Automate tap check on pull requests

  • In a pull request, use singer-check-tap from singer-tools to validate tap output.

  • GitHub actions can be used.

  • A comment should be automatically created to reflect the validation output:

    The output is valid.
    It contained 17 messages for 4 streams.                                                                                                                                         
                                                                                                                                                                                  
          4 schema messages                                                                                                                                                         
          8 record messages                                                                                                                                                         
          5 state messages                                                                                                                                                          
                                                                                                                                                                                  
    Details by stream:                                                                                                                                                              
    +-----------+---------+---------+                                                                                                                                               
    | stream    | records | schemas |                                                       
    +-----------+---------+---------+                                                                                                                                               
    | blogposts | 0       | 1       |                                                                                                                                               
    | groups    | 7       | 1       |                                                                                                                                               
    | spaces    | 1       | 1       |                                                       
    | themes    | 0       | 1       |                                                                                                                                               
    +-----------+---------+---------+
    

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.