<commit_before>========
Overview
========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - | |travis| |codecov|
    * - package
      - |version| |downloads| |wheel| |supported-versions| |supported-implementations|

.. |docs| image:: https://readthedocs.org/projects/mar/badge/?style=flat
    :target: https://readthedocs.org/projects/mar
    :alt: Documentation Status

.. |travis| image:: https://travis-ci.org/mozilla/build-mar.svg?branch=master
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/mozilla/build-mar

.. |codecov| image:: https://codecov.io/github/mozilla/build-mar/coverage.svg?branch=master
    :alt: Coverage Status
    :target: https://codecov.io/github/mozilla/build-mar

.. |version| image:: https://img.shields.io/pypi/v/mar.svg?style=flat
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/mar/

.. |downloads| image:: https://img.shields.io/pypi/dm/mar.svg?style=flat
    :alt: PyPI Package monthly downloads
    :target: https://pypi.org/project/mar/

.. |wheel| image:: https://img.shields.io/pypi/wheel/mar.svg?style=flat
    :alt: PyPI Wheel
    :target: https://pypi.org/project/mar/

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/mar.svg?style=flat
    :alt: Supported versions
    :target: https://pypi.org/project/mar/

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/mar.svg?style=flat
    :alt: Supported implementations
    :target: https://pypi.org/project/mar/


.. end-badges

Package for handling Mozilla Archive files. MAR file format is documented at https://wiki.mozilla.org/Software_Update:MAR

* Free software: MPL 2.0 license

Usage
=====

To list the contents of a mar::

    mar -t complete.mar

To list the contents of a mar with extra detail::

    mar -T complete.mar<commit_msg>bump last-changed-date to avoid archival<commit_after>========
Overview
========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - | |travis| |codecov|
    * - package
      - |version| |downloads| |wheel| |supported-versions| |supported-implementations|

.. |docs| image:: https://readthedocs.org/projects/mar/badge/?style=flat
    :target: https://readthedocs.org/projects/mar
    :alt: Documentation Status

.. |travis| image:: https://travis-ci.org/mozilla/build-mar.svg?branch=master
    :alt: Travis-CI Build Status
    :target: https://travis-ci.org/mozilla/build-mar

.. |codecov| image:: https://codecov.io/github/mozilla/build-mar/coverage.svg?branch=master
    :alt: Coverage Status
    :target: https://codecov.io/github/mozilla/build-mar

.. |version| image:: https://img.shields.io/pypi/v/mar.svg?style=flat
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/mar/

.. |downloads| image:: https://img.shields.io/pypi/dm/mar.svg?style=flat
    :alt: PyPI Package monthly downloads
    :target: https://pypi.org/project/mar/

.. |wheel| image:: https://img.shields.io/pypi/wheel/mar.svg?style=flat
    :alt: PyPI Wheel
    :target: https://pypi.org/project/mar/

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/mar.svg?style=flat
    :alt: Supported versions
    :target: https://pypi.org/project/mar/

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/mar.svg?style=flat
    :alt: Supported implementations
    :target: https://pypi.org/project/mar/

.. end-badges

Package for handling Mozilla Archive files. MAR file format is documented at https://wiki.mozilla.org/Software_Update:MAR

* Free software: MPL 2.0 license

Usage
=====

To list the contents of a mar::

    mar -t complete.mar

To list the contents of a mar with extra detail::

    mar -T complete.mar
{'fraction_non_alphanumeric': 0.16500262743037308, 'fraction_numerical': 0.0015764582238570678, 'mean_word_length': 3.3065610859728505, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 34, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1002359', 'n_tokens_mistral': 1350, 'n_tokens_neox': 1280, 'n_words': 261}