reports

Documentation

Index

• Constants
• func GetSpcfctnCd(db *sql.DB, companyName string, ticker string) string
• func ListCompanies(db *sql.DB) (names []string, err error)
• func ListCompaniesProfits(db *sql.DB, rate float32) error
• func ListSector(db *sql.DB, company, yamlFile string) (err error)
• func ListTickers(db *sql.DB, companyName string) (names []string, err error)
• func ReportToStdout(parms map[string]interface{}) error
• func ReportToXlsx(parms map[string]interface{}) error
• type AccountValue
• type CompanyInfo
• type Excel
• type FIITerminal
  • func NewFIITerminal(db *sql.DB, opts FIITerminalOptions) (*FIITerminal, error)
  • func (t FIITerminal) Dividends(codes []string, n int) error
  • func (t FIITerminal) Monthly(codes []string, n int) error
  • func (t *FIITerminal) SetParms(parms map[string]string)
• type FIITerminalOptions
• type Logger
  • func NewLogger(out io.Writer) *Logger
  • func (l *Logger) Debug(format string, v ...interface{})
  • func (l *Logger) Error(format string, v ...interface{})
  • func (l *Logger) Info(format string, v ...interface{})
  • func (l *Logger) Nok()
  • func (l *Logger) Ok()
  • func (l *Logger) Printf(format string, v ...interface{})
  • func (l *Logger) Run(format string, v ...interface{})
  • func (l *Logger) SetOut(out io.Writer)
  • func (l *Logger) Trace(format string, v ...interface{})
  • func (l *Logger) Warn(format string, v ...interface{})
• type Report
  • func New(parms map[string]interface{}) (*Report, error)
  • func (r Report) LastYearRange(cid int) (int, int, error)
  • func (r Report) RawAccounts(cid, year int) ([]AccountValue, error)
  • func (r *Report) Summary(company string) (map[string]string, error)
• type Sheet
• type TickerInfo

Constants

const (
	DEFAULT = iota + 1

	// Number format
	GENERAL
	NUMBER
	INDEX
	PERCENT

	EMPTY

	// Text position
	LEFT
	RIGHT
	CENTER
)

Used by style

const (
	Rtable = iota + 1
	Rcsv
	Rcsvrend
)

Type of report output

Functions

func GetSpcfctnCd

func GetSpcfctnCd(db *sql.DB, companyName string, ticker string) string

ListTickers returns SpcfctnCd of a ticker

func ListCompanies

func ListCompanies(db *sql.DB) (names []string, err error)

ListCompanies shows all available companies

func ListCompaniesProfits

func ListCompaniesProfits(db *sql.DB, rate float32) error

ListCompaniesProfits lists companies by net profit: more sustainable growth listed first

func ListSector

func ListSector(db *sql.DB, company, yamlFile string) (err error)

ListSector shows all companies from the same sector as 'company'

func ListTickers

func ListTickers(db *sql.DB, companyName string) (names []string, err error)

ListTickers shows all available tickers for a companie name

func ReportToStdout

func ReportToStdout(parms map[string]interface{}) error

ReportToStdout reports company financial data from DB to Stdout.

func ReportToXlsx

func ReportToXlsx(parms map[string]interface{}) error

ReportToXlsx reports company financial data from DB to Excel.

Types

type AccountValue

type AccountValue struct {
	// contains filtered or unexported fields
}

type CompanyInfo

type CompanyInfo struct {
	// contains filtered or unexported fields
}

CompanyInfo contains the company name and CNPJ

type Excel

type Excel struct {
	// contains filtered or unexported fields
}

Excel instance reachable data

type FIITerminal

type FIITerminal struct {
	// contains filtered or unexported fields
}

FIITerminal implements reports related to FII funds on the terminal.

func NewFIITerminal

func NewFIITerminal(db *sql.DB, opts FIITerminalOptions) (*FIITerminal, error)

NewFIITerminal creates a new instace of a FIITerminal

func (FIITerminal) Dividends

func (t FIITerminal) Dividends(codes []string, n int) error

Dividends prints the dividends report on terminal.

func (FIITerminal) Monthly

func (t FIITerminal) Monthly(codes []string, n int) error

func (*FIITerminal) SetParms

func (t *FIITerminal) SetParms(parms map[string]string)

SetParms set the terminal reports parameters.

type FIITerminalOptions

type FIITerminalOptions struct {
	APIKey, DataDir string
}

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(out io.Writer) *Logger

New creates a new Logger

func (*Logger) Debug

func (l *Logger) Debug(format string, v ...interface{})

Debug for debugging information.

func (*Logger) Error

func (l *Logger) Error(format string, v ...interface{})

Error message. Always print to Stderr.

func (*Logger) Info

func (l *Logger) Info(format string, v ...interface{})

Info for something noteworthy.

func (*Logger) Nok

func (l *Logger) Nok()

Nok prints a x mark after a unsuccessful Run()

func (*Logger) Ok

func (l *Logger) Ok()

Ok prints a checkmark after a successful Run()

func (*Logger) Printf

func (l *Logger) Printf(format string, v ...interface{})

Printf prints the plain text.

func (*Logger) Run

func (l *Logger) Run(format string, v ...interface{})

Run prints a message before running a process.

func (*Logger) SetOut

func (l *Logger) SetOut(out io.Writer)

func (*Logger) Trace

func (l *Logger) Trace(format string, v ...interface{})

Trace for very low level logs.

func (*Logger) Warn

func (l *Logger) Warn(format string, v ...interface{})

Warn for a warning message.

type Report

type Report struct {
	// contains filtered or unexported fields
}

Report parameters used in most functions

func New

func New(parms map[string]interface{}) (*Report, error)

func (Report) LastYearRange

func (r Report) LastYearRange(cid int) (int, int, error)

LastYearRange returns the 1st and last day from last year stored on the DB for this company id. Return dates in unix epoch format.

func (Report) RawAccounts

func (r Report) RawAccounts(cid, year int) ([]AccountValue, error)

func (*Report) Summary

func (r *Report) Summary(company string) (map[string]string, error)

type Sheet

type Sheet struct {
	// contains filtered or unexported fields
}

Sheet struct

type TickerInfo

type TickerInfo struct {
	SpcfctnCd string
	// contains filtered or unexported fields
}

TickerInfo contains the ticker name and SpcfctnCd