project-edgar

Local SEC EDGAR workflow wrappers around edgartools. Fetch financial statements, insider trades, 8-K events, and revenue history to CSV.

Requirements

• Python 3.12+
• Git

Setup

git clone https://github.com/dchong1/project-edgar.git
cd project-edgar

python -m venv .venv
.\.venv\Scripts\Activate.ps1

python -m pip install --upgrade pip
pip install -e .

copy .env.example .env
# Edit .env and set EDGAR_IDENTITY=Your Name you@email.com

SEC requires a contact identity for API access. See SEC accessing EDGAR data.

Usage

Interactive fetch (single ticker):

python scripts\fetch.py

Batch fetch (multiple tickers, one report type):

python scripts\batch.py

Single report with CLI args:

python scripts\income_statement.py MU --years 5
python scripts\balance_sheet.py AAPL
python scripts\insider_trades.py MU --years 2

Outputs are saved to data/outputs/ (not tracked in git).

Sync between machines

git pull    # before you start
git push    # when you are done

Each machine needs its own .venv/ and .env. CSV outputs can be re-fetched from SEC.