Arelle 开源项目安装与配置指南

1. 项目基础介绍

Arelle 是一个端到端的开放源代码 XBRL（eXtensible Business Reporting Language）平台，为XBRL社区提供了一套易于使用的工具集。它以可扩展的方式支持XBRL及其扩展功能，并在一个紧凑而健壮的框架中实现，可以作为桌面应用程序使用，也可以通过其Web服务、命令行接口和Python API与其他应用程序和语言集成。

Arelle 项目主要使用 Python 编程语言开发。

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

• Python：项目的主要编程语言。
• XBRL Standards：支持XBRL 2.1、XBRL维度1.0、XBRL公式1.0等多个XBRL标准。
• Web Service API：允许XBRL与Excel、Java或Oracle等应用程序集成。
• Plugin Architecture：插件架构支持扩展功能。
• GUI、CLI、Python API：提供图形用户界面、命令行界面和Python API。
• Validation Rules：支持多个国家的报文程序验证规则。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统满足以下要求：

• 操作系统：支持Windows、macOS、Ubuntu等主流操作系统。
• Python版本：确保安装了Python 3.13或更高版本的Python环境。
• 网络连接：安装过程中需要稳定的网络连接以下载必要的依赖包。

4. 详细安装步骤

以下步骤将在您的系统中安装 Arelle 项目：

步骤 1：克隆项目仓库

首先，您需要在您的计算机上克隆 Arelle 的 GitHub 仓库。打开命令行工具并执行以下命令：

git clone https://github.com/Arelle/Arelle.git

步骤 2：安装依赖

进入项目目录，安装项目所需的依赖。使用以下命令：

cd Arelle
pip install -r requirements.txt

步骤 3：构建项目

在项目目录中，使用以下命令构建 Arelle：

python setup.py build

步骤 4：运行 Arelle

构建完成后，可以通过以下命令运行 Arelle：

• 对于图形界面用户：

python arelleGUI.pyw

• 对于命令行界面用户：

python arelleCmdLine.py

按照上述步骤操作，您应该能够在您的计算机上成功安装并运行 Arelle 项目。如果在安装过程中遇到任何问题，可以查看项目的官方文档或通过 GitHub 的 issue tracker 求助。