Metadata-Version: 2.4
Name: rootfilespec
Version: 0.0.3
Summary: A format specification for ROOT files
Project-URL: Homepage, https://github.com/nsmith-/rootfilespec
Project-URL: Bug Tracker, https://github.com/nsmith-/rootfilespec/issues
Project-URL: Discussions, https://github.com/nsmith-/rootfilespec/discussions
Project-URL: Changelog, https://github.com/nsmith-/rootfilespec/releases
Author-email: Nick Smith <nick.smith@cern.ch>
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: cramjam
Requires-Dist: numpy
Requires-Dist: typing-extensions
Requires-Dist: xxhash
Provides-Extra: dev
Requires-Dist: pytest-cov>=3; extra == 'dev'
Requires-Dist: pytest>=6; extra == 'dev'
Requires-Dist: scikit-hep-testdata; extra == 'dev'
Provides-Extra: docs
Requires-Dist: furo>=2023.08.17; extra == 'docs'
Requires-Dist: myst-parser>=0.13; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: sphinx>=7.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest-cov>=3; extra == 'test'
Requires-Dist: pytest>=6; extra == 'test'
Requires-Dist: scikit-hep-testdata; extra == 'test'
Description-Content-Type: text/markdown

# rootfilespec

[![Actions Status][actions-badge]][actions-link]
[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI version][pypi-version]][pypi-link]
[![Conda-Forge][conda-badge]][conda-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

[![GitHub Discussion][github-discussions-badge]][github-discussions-link]

<!-- SPHINX-START -->

<!-- prettier-ignore-start -->
[actions-badge]:            https://github.com/nsmith-/rootfilespec/workflows/CI/badge.svg
[actions-link]:             https://github.com/nsmith-/rootfilespec/actions
[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/rootfilespec
[conda-link]:               https://github.com/conda-forge/rootfilespec-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]:  https://github.com/nsmith-/rootfilespec/discussions
[pypi-link]:                https://pypi.org/project/rootfilespec/
[pypi-platforms]:           https://img.shields.io/pypi/pyversions/rootfilespec
[pypi-version]:             https://img.shields.io/pypi/v/rootfilespec
[rtd-badge]:                https://readthedocs.org/projects/rootfilespec/badge/?version=latest
[rtd-link]:                 https://rootfilespec.readthedocs.io/en/latest/?badge=latest

<!-- prettier-ignore-end -->

The rootfilespec package is designed to efficiently parse ROOT file binary data
into python datastructures. It does not drive I/O and expects materialized bytes
buffers as input. It also does not return any types beyond python dataclasses of
primitive types (and numpy arrays thereof). The goal of the project is to
provide a stable and feature-complete read/write backend for packages such as
uproot.

Further details on the design decisions can be found in
[docs/design.md](docs/design.md).
