integration_lib

package module
v0.0.0-...-b12c321 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2020 License: MIT Imports: 0 Imported by: 0

README

Integration lib

It aims to be a modular library for integration. There is no strict limitation what to include or not.

Currently, includes (see docs):

  • cloud
    • google sheets
  • communication
    • email
    • telegram
  • finance
    • exchange rates (fiat and crypto)
    • tinkoff investing

Style guide

Plain functions

  • Should have docs
  • Docs should contain API provider(s) if applicable
  • Should have context and context-less (optional) version if uses external services
  • Errors should be wrapped and tagged

Structured

In addition to plain function

  • Configuration structure should not contain state
  • Should have default constructor that fills parameters from environment
  • Environment variables should have prefix, related to the provider (package)
  • Configuration structure could be used as container for functions if functions are not modifying state
  • It's ok to panic in default constructor

Documentation

Overview

Modular library for integration. There is no strict limitation what to include or not.

Directories

Path Synopsis
Cloud integration
Cloud integration
google
Google API integration
Google API integration
Communication endpoints
Communication endpoints
email
Send basic messages over SMTP
Send basic messages over SMTP
telegram
Send basic messages over Telegram
Send basic messages over Telegram
Financial related operations
Financial related operations
rates
Exchange rates for fiat and crypto
Exchange rates for fiat and crypto
tinkoff
Tinkoff (TCS) related financial operations available over API
Tinkoff (TCS) related financial operations available over API
internal
Supporting functions and utilities
Supporting functions and utilities

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL