Skip to main content

Generate XBRL Instances, iXBRL instances, xBRL Taxonomies and xBRL extension taxonomies from distributed sources

Project description

xBRL Forge

Overview

xBRL Forge is an open-source software solution designed to streamline the process of creating final XBRL (eXtensible Business Reporting Language) and iXBRL (Inline XBRL) reports by integrating data from multiple software applications. With xBRL Forge, users can effortlessly generate XBRL taxonomies and compile comprehensive reports using a simple JSON structure for integration.

Features

  • Multi-Source Integration: Seamlessly gather data from various software solutions and compile them into a unified XBRL or iXBRL report.
  • XBRL Taxonomy Generation: Create customizable XBRL taxonomies to meet your reporting needs.
  • Easy JSON Structure: Integrate data using an intuitive and straightforward JSON format.
  • Open Source: Contribute to the community and enhance the functionality of xBRL Forge.

Getting Started

Please refer to this small guide

Documentation

For detailed documentation on how to use xBRL Forge, including API references and examples, please refer to the docs folder.

Contributing

We welcome contributions from the community! To contribute:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/YourFeature
  3. Make your changes and commit them: git commit -m 'Add your feature'
  4. Push to the branch: git push origin feature/YourFeature
  5. Create a pull request.

PLEASE NOTE: this project uses the REBASE STRATEGY

Please ensure your contributions align with the project guidelines.

License

This project is licensed under the APACHE 2.0 License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, feel free to open an issue in the GitHub repository or reach out via email.

Also you can join the discussion on Discord.


Thank you for using xBRL Forge! We look forward to your feedback and contributions!

Project details


Download files

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

Source Distribution

xbrl_forge-0.0.4.tar.gz (537.3 kB view details)

Uploaded Source

Built Distribution

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

xbrl_forge-0.0.4-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file xbrl_forge-0.0.4.tar.gz.

File metadata

  • Download URL: xbrl_forge-0.0.4.tar.gz
  • Upload date:
  • Size: 537.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xbrl_forge-0.0.4.tar.gz
Algorithm Hash digest
SHA256 6c0b13e3fd1100449439d7ef236ab3b443ac2f6b810daef22886c4d080f37a5e
MD5 29007f36586377c5e89b6c302e00048d
BLAKE2b-256 e9240c62763da580055da2b505b0ee48c99de96ef06846d00e3c7e47f6d241cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for xbrl_forge-0.0.4.tar.gz:

Publisher: publish_to_pypi.yml on antonheitz/xBRL-Forge

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

File details

Details for the file xbrl_forge-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: xbrl_forge-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for xbrl_forge-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 427b52f69bdb040f0148852c256c62b92529f5f5f310a0db782440105588826c
MD5 e5d9f306fd6f9cf5ac88c33f9fe7c030
BLAKE2b-256 afce5a666ca40c85b5c46dd9971a9d7f220045cba02a20911fda2f05bd3e6b07

See more details on using hashes here.

Provenance

The following attestation bundles were made for xbrl_forge-0.0.4-py3-none-any.whl:

Publisher: publish_to_pypi.yml on antonheitz/xBRL-Forge

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