edgar

command module
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Apr 23, 2024 License: MIT Imports: 3 Imported by: 0

README

Go

Download data files from EDGAR

Right now this project is under constraction.

Install

Install edgar cli using

$ go install github.com/dsh2dsh/edgar@latest

or execute it directly using

$ go run github.com/dsh2dsh/edgar@latest

Usage

Before using this programm, you need postgresql instance. Create an .env file with content like this:

EDGAR_DB_URL="postgres://username:password@localhost:5432/database_name
EDGAR_UA="Sample Company Name AdminContact@<sample company domain>.com"

Replace company name and contact info to your real info and initialize the db:

$ edgar db init

Download all facts into the db:

$ edgar db upload

Periodically fetch new facts:

$ edgar db update

How to test

You need postgresql instance. In project's directory create .env file:

EDGAR_DB_URL="postgres://username:password@localhost:5432/database_name
EDGAR_UA="Sample Company Name AdminContact@<sample company domain>.com"

Replace company name and contact info to your real info and do:

$ make test

It runs all local tests. For running E2E tests, which fetches real data from EDGAR, do:

$ make test-e2e

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package client implements API access to EDGAR data.
Package client implements API access to EDGAR data.
cmd
db
internal

Jump to

Keyboard shortcuts

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