reports

Documentation

Index

• Constants
• func HTMLServer(opts ...ServerOption)
• 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 Report(p Parms) error
• type CompanyInfo
• type Excel
• type FIITerminal
  • func NewFIITerminal(db *sql.DB, apiKey, dataDir string) (*FIITerminal, error)
  • func (t FIITerminal) Dividends(codes []string, n int) error
  • func (t *FIITerminal) SetParms(parms map[string]string)
• 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 Parms
• type Server
• type ServerOption
  • func WithAPIKey(apiKey string) ServerOption
  • func WithDB(db *sql.DB) ServerOption
  • func WithDataDir(dataDir string) ServerOption
• type Sheet

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 HTMLServer

func HTMLServer(opts ...ServerOption)

HTMLServer is a very basic html server to show the reports.

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 Report

func Report(p Parms) error

Report of company data from DB to Excel

Types

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, apiKey, dataDir string) (*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) SetParms

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

SetParms set the terminal reports parameters.

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 Parms

type Parms struct {
	// DB database handle
	DB *sql.DB
	// Company name to be processed
	Company string
	// Filename: path and filename of the output xlsx
	Filename string
	// YamlFile: file with the companies' sectors
	YamlFile string
	// Reports is a map with the reports and reports items to be printed:
	// - ExtraRatios: enables some extra financial ratios on report
	// - ShowShares: shows the number of shares and free float on report
	// - Sector: creates a sheet with the sector report
	Reports map[string]bool
}

Parms holds the input parameters

type Server

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

type ServerOption

type ServerOption func(*Server)

func WithAPIKey

func WithAPIKey(apiKey string) ServerOption

func WithDB

func WithDB(db *sql.DB) ServerOption

func WithDataDir

func WithDataDir(dataDir string) ServerOption

type Sheet

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

Sheet struct