Skip to main content

An open source XBRL platform.

Project description

Arelle

PyPI PyPI - Python Version Read the Docs

Arelle Banner

Table of Contents

Description

Arelle is an end-to-end open source XBRL platform, which provides the XBRL community with an easy to use set of tools. It supports XBRL and its extension features in an extensible manner. It does this in a compact yet robust framework that can be used as a desktop application and can be integrated with other applications and languages utilizing its web service, command line interface, and Python API.

Documentation

Need help with Arelle? Go check out our documentation.

Features

  • Fully-featured XBRL processor with GUI, CLI, Python API and Web Service API.
  • Support for the XBRL Standard, including:
    • XBRL v2.1 and XBRL Dimensions v1.0
    • XBRL Formula v1.0
    • Taxonomy Packages v1.0
    • xBRL-JSON v1.0 and xBRL-CSV v1.0
    • Inline XBRL v1.1
    • Units Registry v1.0
  • Certified by XBRL International as a Validating Processor.
  • Support for filing programme validation rules:
    • Edgar Filer Manual validation (US SEC)
    • ESEF Reporting Manual (EU)
    • HMRC (UK)
    • CIPC (South Africa)
    • FERC (US Federal Energy Regulatory Commission)
  • Integrated support for Arelle Inline XBRL Viewer.
  • Extensible plugin architecture.
  • Support for XF text-based Formula and XULE validation rules.
  • The Web Service API allows XBRL integration with applications, such as those in Excel, Java or Oracle.
  • Instance creation is supported using forms defined by the table linkbase.
  • Support for reading/monitoring US SEC XBRL RSS feeds (RSS Watch).

Need Support?

Whether you've found a bug, need help with installation, have a feature request, or want to know how to use Arelle, we can help! Here's a quick guide:

When reporting issues it's important to include as much information as possible:

  • what version of Arelle are you using?
  • how are you using Arelle (GUI, command line, web server, or the Python API?)
  • what operating system (Windows, macOS, Ubuntu, etc.) are you using?
  • what plugins if any do you have enabled?
  • can you provide an XBRL report that recreates the issue?
  • what's the diagnostics output (arelleCmdLine.exe --diagnostics) on your system?

Arelle Within Other Products

A number of service providers embed Arelle within their XBRL products and tools. If you're having an issue with Arelle within one of these offerings please contact the developer of that tool for support or first verify that you have the same issue when using Arelle directly. Most issues in these situations are caused by the tool using an old version of Arelle or not running a valid command.

EDGAR or EFM Validations

The SEC develops and maintains the EDGAR plugins. Please report issues with these plugins directly to the SEC (StructuredData@sec.gov).

Installing or Running Arelle

Most installation and startup issues can be resolved by downloading the latest version of Arelle and performing a clean install. If that doesn't resolve the problem for you, please report a bug.

Bug Report or Feature Request

Please use the GitHub issue tracker if you'd like to suggest a new feature or report a bug.

Before opening a new issue, please:

  • Check that the issue has not already been reported.
  • Check that the issue has not already been fixed in the latest release.
  • Be clear and precise (do not prose, but name functions and commands exactly).
  • For bug reports include the version of Arelle you're using.

Security Vulnerabilities

Identified a security concern? Email the Arelle team (Support@arelle.org) so we can resolve the issue and make sure service providers and authorities who use Arelle in production are prepared to update and apply security patches before notifying the general public.

How-To and General XBRL Questions

Have a question that isn't covered by the documentation? Join our Arelle Google Group and start a conversation with the Arelle team and community of experts.

Email

The Arelle team can also be reached by email (Support@arelle.org) for issues that aren't a good fit for the other support channels. However, please note that you will likely receive a faster response if you open a GitHub issue or start a new conversation in the Arelle Google Group where the Arelle team is active and other people within the community can also see and respond to your message.

How To Contribute

Interested in contributing to Arelle? Awesome! Make sure to review our contribution guidelines.

👥 Contributors

Join our community and become a contributor today! 🚀

License

Apache License 2.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arelle_release-2.41.1.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arelle_release-2.41.1-py3-none-any.whl (5.8 MB view details)

Uploaded Python 3

File details

Details for the file arelle_release-2.41.1.tar.gz.

File metadata

  • Download URL: arelle_release-2.41.1.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for arelle_release-2.41.1.tar.gz
Algorithm Hash digest
SHA256 17c8e3ea28484d8a78a182fbd9efe41498fd1be9a3f682e27afc87fedfb9064f
MD5 b0329f6cb8f9056ca3a165c17ee66016
BLAKE2b-256 df0757ad1a4da978f4839c30df7e43505c639a3a9e9f0717cda6687fb94b638a

See more details on using hashes here.

Provenance

The following attestation bundles were made for arelle_release-2.41.1.tar.gz:

Publisher: release.yml on Arelle/Arelle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file arelle_release-2.41.1-py3-none-any.whl.

File metadata

File hashes

Hashes for arelle_release-2.41.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da08a2a63b305060632356513a6e1fbc2161a1b772020364b6934ac0f52381a2
MD5 1a22db5646fbf885fcc5288c9cc4d40b
BLAKE2b-256 950f19667a6444892a6e341e7cff23ee7c3f2467b0ac6e6f22906adb154eb32c

See more details on using hashes here.

Provenance

The following attestation bundles were made for arelle_release-2.41.1-py3-none-any.whl:

Publisher: release.yml on Arelle/Arelle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page