SEC 13F Filings 开源项目使用教程

SEC 13F Filings 开源项目使用教程

sec-13f-filingsA nicer way to view SEC 13F filings data项目地址:https://gitcode.com/gh_mirrors/se/sec-13f-filings

1. 项目的目录结构及介绍

sec-13f-filings/
├── README.md
├── data/
│   ├── 13f_filings.csv
│   └── ...
├── scripts/
│   ├── download_filings.py
│   ├── process_filings.py
│   └── ...
├── config/
│   ├── config.yaml
│   └── ...
├── requirements.txt
└── main.py

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• data/: 存储下载的13F文件和其他相关数据。
• scripts/: 包含用于下载和处理13F文件的脚本。
• config/: 项目的配置文件目录。
• requirements.txt: 列出了项目所需的Python依赖包。
• main.py: 项目的启动文件。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责初始化项目并执行主要的逻辑流程。以下是该文件的主要功能：

• 初始化配置: 从 config/config.yaml 中读取配置参数。
• 下载13F文件: 调用 scripts/download_filings.py 脚本下载最新的13F文件。
• 处理13F文件: 调用 scripts/process_filings.py 脚本处理下载的13F文件，并将其存储在 data/ 目录中。
• 生成报告: 根据处理后的数据生成报告，并输出到指定目录。

3. 项目的配置文件介绍

config/config.yaml

config.yaml 是项目的配置文件，包含了项目运行所需的各种参数。以下是该文件的主要内容：

# 下载13F文件的配置
download:
  url: "https://www.sec.gov/files/edgar/data/13f-hr.zip"
  output_dir: "data/"

# 处理13F文件的配置
process:
  input_dir: "data/"
  output_dir: "output/"

# 其他配置
other:
  log_level: "INFO"
  max_workers: 4

配置文件介绍

• download: 配置下载13F文件的URL和输出目录。
• process: 配置处理13F文件的输入目录和输出目录。
• other: 其他配置，如日志级别和最大工作线程数。

通过修改 config.yaml 文件，可以自定义项目的运行参数，以适应不同的需求。

sec-13f-filingsA nicer way to view SEC 13F filings data项目地址:https://gitcode.com/gh_mirrors/se/sec-13f-filings