Metadata-Version: 2.4
Name: swh.mosaic
Version: 0.1.1
Summary: MOdular Storage of Archived and Indexed Contents from Software Heritage
Author-email: Software Heritage developers <swh-devel@inria.fr>
License-Expression: GPL-3.0
Project-URL: Homepage, https://gitlab.softwareheritage.org/swh/devel/swh-mosaic
Project-URL: Bug Reports, https://gitlab.softwareheritage.org/swh/devel/swh-mosaic/-/issues
Project-URL: Funding, https://www.softwareheritage.org/donate
Project-URL: Documentation, https://docs.softwareheritage.org/devel/swh-mosaic/
Project-URL: Source, https://gitlab.softwareheritage.org/swh/devel/swh-mosaic.git
Classifier: Programming Language :: Rust
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Provides-Extra: testing
Requires-Dist: pytest>=8.1; extra == "testing"
Dynamic: license-file

swh.mosaic: MOdular Storage of Archived and Indexed Contents from Software Heritage
===================================================================================

MOSAIC is a file format designed to efficiently store and randomly read contents
archived by `Software Heritage <https://softwareheritage.org>`_.
Target content is source code and therefore small objects (median size: 3kb), indexed
over one (or more) of `the possible objstorage keys <https://docs.softwareheritage.org/devel/apidoc/swh.storage.interface.html#swh.storage.interface.HashDict>`_.

The motivations and design of this file format are thoroughly explained in
`SWH Enhancement Proposal #5 <https://gitlab.softwareheritage.org/swh/swhep/-/blob/main/swheps/0005.md>`_.
Format evolutions are described in ``CHANGELOG.md`` in the package's sources.

The Python module provides high-level classes (implemented in Rust) to read/write MOSAIC files.
