Metadata-Version: 1.1
Name: bitstream
Version: 2.6.0.1
Summary: Binary Data for Humans
Home-page: https://github.com/boisgera/bitstream
Author: Sébastien Boisgérault
Author-email: Sebastien.Boisgerault@mines-paristech.fr
License: MIT License
Description: |Python| |PyPI version| |Mkdocs| |status| |Travis Build Status|
        |Appveyor Build status|
        
        Bitstream
        =========
        
        A Python library to manage binary data as
        `bitstreams <https://en.wikipedia.org/wiki/Bitstream>`__.
        
        Overview
        --------
        
        Bitstream three main features:
        
        -  It is easy to use since the bitstream abstraction is simple.
        
        -  It works seamlesly at the bit and byte level.
        
        -  It supports Python, NumPy and user-defined types.
        
        See the documentation `Overview <http://boisgera.github.io/bitstream>`__
        section for more details.
        
        Quickstart
        ----------
        
        Make sure that Python 2.7 or Python 3.6 to 3.9 are installed and that
        pip, NumPy and a C compiler are available, then install bitstream with
        
        ::
        
           $ pip install bitstream
        
        For more details, refer to `the
        documentation <http://boisgera.github.io/bitstream/installation/>`__.
        
        Examples
        --------
        
        First, the mandatory “Hello World!” example:
        
        ::
        
           >>> from bitstream import BitStream
           >>> BitStream(b"Hello World!")
           010010000110010101101100011011000110111100100000010101110110111101110010011011000110010000100001
        
        The basic API is made of three methods only:
        
        -  ``stream = BitStream()`` to create an empty stream.
        
        -  ``stream.write(data, type)`` to write data ``data`` of type ``type``.
        
        -  ``data = stream.read(type, n)`` to read ``n`` items of type ``type``.
        
        For example:
        
        ::
        
           >>> stream = BitStream()        # <empty>
           >>> stream.write(True, bool)    # 1
           >>> stream.write(False, bool)   # 10
           >>> from numpy import int8
           >>> stream.write(-128, int8)    # 1010000000
           >>> stream.write(b"AB", bytes)  # 10100000000100000101000010
           >>> stream.read(bool, 2)        # 100000000100000101000010
           [True, False]
           >>> stream.read(int8, 1)        # 0100000101000010
           array([-128], dtype=int8)
           >>> stream.read(bytes, 2)       # <empty>
           b'AB'
        
        Refer to the documentation
        `Overview <http://boisgera.github.io/bitstream/>`__ section for more
        elementary examples.
        
        Contributing
        ------------
        
        Refer to
        `Contributing <http://boisgera.github.io/bitstream/contributing>`__ in
        the documentation.
        
        Support
        -------
        
        If you need some support with bitstream and you haven’t found a solution
        to your problem `in the
        documentation <http://boisgera.github.io/bitstream/>`__, please open an
        issue in the `GitHub issue
        tracker <https://github.com/boisgera/bitstream/issues>`__.
        
        If you don’t feel like you problem belongs there, you can send me an
        e-mail instead; please include “bitstream” in the subject. You will find
        my e-mail address in my `GitHub
        profile <https://github.com/boisgera>`__.
        
        In both cases, you will need to sign into GitHub (and `join
        GitHub <https://github.com/join>`__ if you don’t already have an
        account).
        
        License
        -------
        
        Bitstream is open source software released under the `MIT
        license <https://github.com/boisgera/bitstream/blob/master/LICENSE.txt>`__.
        
        Copyright (c) 2012-2020 Sébastien Boisgérault
        
        .. |Python| image:: https://img.shields.io/pypi/pyversions/bitstream.svg
        .. |PyPI version| image:: https://img.shields.io/pypi/v/bitstream.svg
           :target: https://pypi.python.org/pypi/bitstream
        .. |Mkdocs| image:: https://img.shields.io/badge/doc-mkdocs-blue.svg
           :target: http://boisgera.github.io/bitstream
        .. |status| image:: http://joss.theoj.org/papers/dd351bf2ed414a623557bb51d75b2536/status.svg
           :target: http://joss.theoj.org/papers/dd351bf2ed414a623557bb51d75b2536
        .. |Travis Build Status| image:: https://travis-ci.org/boisgera/bitstream.svg?branch=master
           :target: https://travis-ci.org/boisgera/bitstream
        .. |Appveyor Build status| image:: https://ci.appveyor.com/api/projects/status/7r59rbtqam0w11fq?svg=true
           :target: https://ci.appveyor.com/project/boisgera/bitstream
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Cython
