parsers

Documentation

Index

• Constants
• func FromSector(company, yamlFile string) (companies []string, sectorName string, err error)
• func FuzzyFind(source string, targets []string, maxDistance int) (found string)
• func FuzzyMatch(src string, list []string, distance int) bool
• func Hash(s string) uint32
• func ImportCsv(db *sql.DB, dataType string, file string) (err error)
• func RemoveDiacritics(original string) (result string)
• func SectorsToYaml(yamlFile string) (err error)
• type S
• type Sector
• type Segment
• type Subsector

Constants

const (
	UNDEF uint32 = iota
	SPACE

	// Balance Sheet
	Caixa
	AplicFinanceiras
	Estoque
	Equity
	DividaCirc
	DividaNCirc

	// Income Statement
	Vendas
	CustoVendas
	DespesasOp
	EBIT
	LucLiq

	// DFC
	FCO
	FCI
	FCF

	// Value Added Statement
	Deprec
	JurosCapProp
	Dividendos
)

Bookkeeping account codes If you add new const values, run 'go generate' to update the generated code

Functions

func FromSector

func FromSector(company, yamlFile string) (companies []string, sectorName string, err error)

FromSector returns all companies from the same sector as the 'company'

func FuzzyFind

func FuzzyFind(source string, targets []string, maxDistance int) (found string)

FuzzyFind returns the most approximate string inside 'list' that matches the 'src' string within a maximum 'distance'.

func FuzzyMatch

func FuzzyMatch(src string, list []string, distance int) bool

FuzzyMatch measures the Levenshtein distance between the source and the list, returning true if the distance is less or equal the 'distance'. Diacritics are removed from 'src' and 'list'.

func Hash

func Hash(s string) uint32

Hash returns the FNV-1 non-cryptographic hash

func ImportCsv

func ImportCsv(db *sql.DB, dataType string, file string) (err error)

ImportCsv start the data import process, including the database creation if necessary

func RemoveDiacritics

func RemoveDiacritics(original string) (result string)

RemoveDiacritics transforms, for example, "žůžo" into "zuzo"

func SectorsToYaml

func SectorsToYaml(yamlFile string) (err error)

SectorsToYaml grab data from B3 website and prints out to a yaml file with all companies grouped by sector, subsector, segment

Types

type S

type S struct {
	Sectors []Sector `yaml:"Setores"`
}

S contains the sectors

type Sector

type Sector struct {
	Name       string      `yaml:"Setor"`
	Subsectors []Subsector `yaml:"Subsetores"`
}

Sector is divided into subsectors

type Segment

type Segment struct {
	Name      string   `yaml:"Segmento"`
	Companies []string `yaml:"Empresas"`
}

Segment contains companies from the same sector/subsector/segment

type Subsector

type Subsector struct {
	Name     string    `yaml:"Subsetor"`
	Segments []Segment `yaml:"Segmentos"`
}

Subsector is divided into segments