Python-EDGAR 项目教程
1. 项目的目录结构及介绍
python-edgar/
├── README.md
├── setup.py
├── edgar/
│ ├── __init__.py
│ ├── downloader.py
│ ├── parser.py
│ └── config.py
├── tests/
│ ├── __init__.py
│ └── test_downloader.py
└── docs/
└── usage.md
- README.md: 项目介绍和使用说明。
- setup.py: 项目安装脚本。
- edgar/: 核心代码目录。
- init.py: 模块初始化文件。
- downloader.py: 下载EDGAR文件的模块。
- parser.py: 解析EDGAR文件的模块。
- config.py: 配置文件处理模块。
- tests/: 测试代码目录。
- init.py: 测试模块初始化文件。
- test_downloader.py: 下载模块的测试文件。
- docs/: 文档目录。
- usage.md: 使用说明文档。
2. 项目的启动文件介绍
项目的启动文件是 edgar/downloader.py
。该文件包含了下载EDGAR文件的主要功能。以下是该文件的主要内容:
import requests
from config import Config
class Downloader:
def __init__(self, config: Config):
self.config = config
def download_index(self, download_directory, since_year, user_agent):
# 下载逻辑
pass
__init__
方法: 初始化下载器,接受一个配置对象。download_index
方法: 下载EDGAR索引文件的逻辑。
3. 项目的配置文件介绍
项目的配置文件是 edgar/config.py
。该文件包含了项目的配置信息。以下是该文件的主要内容:
class Config:
def __init__(self):
self.base_url = "https://www.sec.gov/Archives/edgar/full-index/"
self.user_agent = "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"
self.download_directory = "./downloads"
self.since_year = 2010
base_url
: EDGAR文件的基础URL。user_agent
: 请求头中的User-Agent信息。download_directory
: 下载文件的存储目录。since_year
: 下载文件的起始年份。
以上是 python-edgar
项目的基本教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!