Metadata-Version: 2.4
Name: stream-read-xbrl
Version: 0.1.3
Summary: Python package to parse Companies House accounts data in a streaming way
Project-URL: Documentation, https://stream-read-xbrl.docs.trade.gov.uk/
Project-URL: Source, https://github.com/uktrade/stream-read-xbrl
Author-email: Department for Business and Trade <sre@digital.trade.gov.uk>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.14,>=3.9.0
Requires-Dist: beautifulsoup4>=4.14.3
Requires-Dist: httpx>=0.27.2
Requires-Dist: lxml>=6.0.2
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: stream-unzip>=0.0.99
Description-Content-Type: text/markdown

<!-- --8<-- [start:intro] -->
# 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.
<!-- --8<-- [end:intro] -->


<!-- --8<-- [start:features] -->
<!-- --8<-- [end:features] -->

---

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