Edinet XBRL 项目使用教程

Edinet XBRL 项目使用教程

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

edinet_xbrl/
├── edinet_xbrl/
│   ├── __init__.py
│   ├── edinet_xbrl_downloader.py
│   ├── edinet_xbrl_parser.py
│   └── ...
├── tests/
│   ├── __init__.py
│   └── ...
├── .gitignore
├── .travis.yml
├── LICENSE.txt
├── MANIFEST.in
├── README.rst
├── setup.cfg
├── setup.py
└── tox.ini

• edinet_xbrl/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件。
  • edinet_xbrl_downloader.py: 用于下载XBRL文件的模块。
  • edinet_xbrl_parser.py: 用于解析XBRL文件的模块。
• tests/: 包含项目的测试代码。
• .gitignore: Git忽略文件配置。
• .travis.yml: Travis CI配置文件。
• LICENSE.txt: 项目许可证文件。
• MANIFEST.in: 打包清单文件。
• README.rst: 项目说明文档。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• tox.ini: Tox配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 setup.py，它负责项目的安装和分发。通过运行以下命令可以安装项目：

pip install edinet-xbrl

3. 项目的配置文件介绍

• setup.cfg: 包含项目的安装配置信息，如包的元数据、依赖等。
• tox.ini: 用于配置Tox自动化测试环境。
• .travis.yml: 用于配置Travis CI持续集成环境。

这些配置文件确保项目能够正确安装和测试，同时也方便了项目的持续集成和分发。