https://github.com/uktrade/stream-read-xbrl

Python package to parse Companies House accounts data in a streaming way
https://github.com/uktrade/stream-read-xbrl

data-infrastructure diapp

Last synced: 4 months ago
JSON representation

Python package to parse Companies House accounts data in a streaming way

• Host: GitHub
• URL: https://github.com/uktrade/stream-read-xbrl
• Owner: uktrade
• License: mit
• Created: 2023-03-02T09:37:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2026-01-12T19:54:59.000Z (5 months ago)
• Last Synced: 2026-01-18T08:25:31.586Z (5 months ago)
• Topics: data-infrastructure, diapp
• Language: Python
• Homepage: https://stream-read-xbrl.docs.trade.gov.uk/
• Size: 1.58 MB
• Stars: 0
• Watchers: 23
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Security: SECURITY_CHECKLIST.md

Awesome Lists containing this project

README

          

# stream-read-xbrl

[![PyPI package](https://img.shields.io/pypi/v/stream-read-xbrl?label=PyPI%20package&color=%234c1)](https://pypi.org/project/stream-read-xbrl/) [![Test suite](https://img.shields.io/github/actions/workflow/status/uktrade/stream-read-xbrl/tests.yml?label=Test%20suite)](https://github.com/uktrade/stream-read-xbrl/actions/workflows/tests.yml) [![Code coverage](https://img.shields.io/codecov/c/github/uktrade/stream-read-xbrl?label=Code%20coverage)](https://app.codecov.io/gh/uktrade/stream-read-xbrl)

Python package to parse [Companies House accounts data](http://download.companieshouse.gov.uk/en_accountsdata.html) in a streaming way. It converts the zipped XBRL format that Companies House supplies into a single data frame of 38 columns.

On a standard laptop with 8 CPU cores it takes approximately 10 seconds to convert a single day of Companies House accounts data. This does not include the time to transfer the data from Companies House.

---

Visit the [stream-read-xbrl documentation](https://stream-read-xbrl.docs.trade.gov.uk/) for usage instructions.