sec-edgar-downloader 项目使用教程

sec-edgar-downloader 项目使用教程

sec-edgar-downloader 📈 Download filings from the SEC EDGAR database using Python 项目地址: https://gitcode.com/gh_mirrors/se/sec-edgar-downloader

1. 项目目录结构及介绍

sec-edgar-downloader 是一个用于从美国证券交易委员会（SEC）EDGAR 数据库下载公司文件的 Python 包。以下是项目的目录结构及各部分的简要介绍：

sec-edgar-downloader/
├── .github/                # GitHub 工作流程和配置文件
├── docs/                   # 项目文档
├── requirements/           # 项目依赖文件
├── sec_edgar_downloader/   # 包含项目核心代码
├── tests/                  # 包含单元测试
├── .gitignore              # 指定 Git 忽略的文件
├── CHANGELOG.md            # 项目更新日志
├── LICENSE                 # 项目许可证
├── Makefile                # Makefile 文件用于构建项目
├── README.rst              # 项目说明文件
├── pyproject.toml          # 项目配置文件
└── tox.ini                 # tox 配置文件，用于自动化测试

• .github/：包含 GitHub Actions 工作流程文件，用于自动化代码测试、构建等。
• docs/：存放项目的文档资料。
• requirements/：包含项目运行所需的依赖库列表。
• sec_edgar_downloader/：包含项目的所有 Python 代码和模块。
• tests/：包含对项目代码进行单元测试的代码。
• .gitignore：定义了在 Git 版本控制中应该忽略的文件和目录。
• CHANGELOG.md：记录了项目的所有更新和改动历史。
• LICENSE：项目所使用的许可证信息。
• Makefile：用于构建和测试项目的自动化脚本。
• README.rst：项目的基本介绍和说明。
• pyproject.toml：定义了项目的元数据和依赖。
• tox.ini：tox 的配置文件，用于在多个 Python 版本上运行测试。

2. 项目的启动文件介绍

项目的启动文件是 sec_edgar_downloader/__init__.py。这个文件初始化了 sec_edgar_downloader 包，并导入了主要的类和函数，使得它们可以直接通过包名访问。

# __init__.py 示例内容
from .downloader import Downloader

__version__ = '包版本号'

通过导入 Downloader 类，用户可以创建一个下载器实例，用来从 SEC EDGAR 数据库下载文件。

3. 项目的配置文件介绍

项目的配置文件是 pyproject.toml，它包含了项目的元数据、依赖项和构建系统等信息。

[tool.poetry]
name = "sec-edgar-downloader"
version = "0.1.0"
description = "Python package for downloading SEC EDGAR filings"
authors = ["Jad Chaar <jadchaar@example.com>"]

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^6.2"
tox = "^3.24"

在这个配置文件中：

• name 定义了项目的名称。
• version 定义了项目的版本号。
• description 提供了关于项目的简短描述。
• authors 列出了项目的作者及其联系信息。
• 在 dependencies 部分，定义了项目运行所需的依赖，这里是 Python 3.8。
• 在 dev-dependencies 部分，定义了开发过程中需要的依赖，例如 pytest 和 tox。

sec-edgar-downloader 📈 Download filings from the SEC EDGAR database using Python 项目地址: https://gitcode.com/gh_mirrors/se/sec-edgar-downloader