sec-edgar-downloader安装与配置指南

1. 项目基础介绍

sec-edgar-downloader 是一个开源项目，旨在帮助用户使用Python语言下载美国证券交易委员会（SEC）EDGAR数据库中的公司报告和文件。EDGAR数据库是一个存储所有在美国证券市场上市的公司公开财务报告和披露文件的重要数据库。

主要编程语言：Python

2. 项目使用的关键技术和框架

此项目使用的关键技术主要包括网络请求处理、文件解析和Python标准库。没有使用特定的框架，但依赖于一些第三方Python库，例如requests用于发送网络请求，lxml用于解析HTML和XML文件。

3. 项目安装和配置的准备工作与详细步骤

准备工作：

• 确保您的系统中已安装Python（版本至少为3.6）。
• 安装pip，Python的包管理器（通常Python安装时会自带pip）。
• 确保您的系统可以连接到互联网。

安装步骤：

1. 打开命令行工具（如终端或命令提示符）。

2. 首先确保pip已更新到最新版本，输入以下命令更新pip：

   pip install --upgrade pip
   

3. 使用pip安装sec-edgar-downloader，输入以下命令：

   pip install sec-edgar-downloader
   

4. 安装完成后，可以通过以下Python代码测试安装是否成功：

   from sec_edgar_downloader import Downloader
   
   dl = Downloader("YourCompanyName", "[e-mail]")
   print(dl.supported_filings)  # 输出支持下载的文件类型列表
   

   如果没有报错，并且输出了支持的文件类型列表，那么安装成功。

5. 开始使用sec-edgar-downloader下载文件，例如下载某个公司的8-K报告：

   dl.get("8-K", "AAPL")
   

以上步骤将指导用户从零开始安装并配置sec-edgar-downloader，从而能够下载所需的公司报告。