Git Product home page Git Product logo

turbot / steampipe-plugin-mastodon Goto Github PK

View Code? Open in Web Editor NEW
14.0 9.0 1.0 483 KB

Use SQL to instantly query Mastodon resources. Open source CLI. No DB required.

Home Page: https://hub.steampipe.io/plugins/turbot/mastodon

License: Apache License 2.0

Makefile 0.17% PLSQL 1.12% Go 98.70%
go golang mastodon postgresql postgresql-fdw steampipe steampipe-plugin hacktoberfest sql backup etl sqlite zero-etl

steampipe-plugin-mastodon's Introduction

Mastodon plugin for Steampipe

Use SQL to instantly query Mastodon timelines, accounts, followers and more. Open source CLI. No DB required.

Quick start

Install

Download and install the latest Mastodon plugin:

steampipe plugin install mastodon

Credentials

Item Description
Credentials All API requests require a Mastodon Access Token.
Permissions API tokens have the same permissions as the user who creates them, and if the user permissions change, the API token permissions also change.
Radius Each connection represents a single Mastodon installation.
Resolution 1. Credentials explicitly set in a steampipe config file (~/.steampipe/config/mastodon.spc)

Configuration

Installing the latest mastodon plugin will create a config file (~/.steampipe/config/mastodon.spc) with a single connection named mastodon:

connection "mastodon" {
    plugin = "mastodon"

    # `server` (required) - The federated server your account lives. Ex: mastodon.social, nerdculture.de, etc
    # server = "https://myserver.social"

    # `access_token` (required) - Get your access token by going to your Mastodon server, then: Settings -> Development -> New Application
    # Refer to this page for more details: https://docs.joinmastodon.org/client/token
    # access_token = "FK1_gBrl7b9sPOSADhx61-uvagzv9EDuMrXuc1AlcNU"

    # `app` (optional) - Allows you to follow links to Elk instead of stock client
    # app = "elk.zone"

    # `max_toots` (optional) - Defines the maximum number of toots to list in the mastodon toot tables.
    # If not set, the default is 1000. To avoid limiting, set max_toots = -1
    # max_toots = 1000
}
  • access_token - The token to access the Mastodon APIs. This is required while querying all the tables except mastodon_rule, mastodon_peer, mastodon_server, mastodon_weekly_activity, and mastodon_domain_block tables.

Engines

This plugin is available for the following engines:

Engine Description
Steampipe The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.
Postgres FDW Steampipe Postgres FDWs are native Postgres Foreign Data Wrappers that translate APIs to foreign tables. Unlike Steampipe CLI, which ships with its own Postgres server instance, the Steampipe Postgres FDWs can be installed in any supported Postgres database version.
SQLite Extension Steampipe SQLite Extensions provide SQLite virtual tables that translate your queries into API calls, transparently fetching information from your API or service as you request it.
Export Steampipe Plugin Exporters provide a flexible mechanism for exporting information from cloud services and APIs. Each exporter is a stand-alone binary that allows you to extract data using Steampipe plugins without a database.
Turbot Pipes Turbot Pipes is the only intelligence, automation & security platform built specifically for DevOps. Pipes provide hosted Steampipe database instances, shared dashboards, snapshots, and more.

Developing

Prerequisites:

Clone:

git clone https://github.com/turbot/steampipe-plugin-mastodon
cd steampipe-plugin-mastodon

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/mastodon.spc

Try it!

steampipe query
> .inspect mastodon

Further reading:

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues:

steampipe-plugin-mastodon's People

Contributors

dependabot[bot] avatar judell avatar luisffc avatar madhushreeray30 avatar misraved avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ralfbarkow

steampipe-plugin-mastodon's Issues

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.