| Name | bitstring JSON |
| Version |
4.2.3
JSON |
| download |
| home_page | None |
| Summary | Simple construction, analysis and modification of binary data. |
| upload_time | 2024-05-25 21:08:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
binary
bitarray
bitvector
bitfield
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
**bitstring** is a Python module to help make the creation and analysis of all types of bit-level binary data as simple and efficient as possible.
It has been actively maintained since 2006.
[](https://github.com/scott-griffiths/bitstring/actions/workflows/ci.yml)
[](https://bitstring.readthedocs.io/en/latest/)
[](https://app.codacy.com/gh/scott-griffiths/bitstring/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://libraries.io/pypi/bitstring)
[](https://www.pepy.tech/projects/bitstring)
[](https://pypistats.org/packages/bitstring)
----
> [!NOTE]
> To see what been added, improved or fixed, and also to see what's coming in the next version, see the [release notes](https://github.com/scott-griffiths/bitstring/blob/main/release_notes.md).
# Overview
* Efficiently store and manipulate binary data in idiomatic Python.
* Create bitstrings from hex, octal, binary, files, formatted strings, bytes, integers and floats of different endiannesses.
* Powerful binary packing and unpacking functions.
* Bit-level slicing, joining, searching, replacing and more.
* Create and manipulate arrays of fixed-length bitstrings.
* Read from and interpret bitstrings as streams of binary data.
* Rich API - chances are that whatever you want to do there's a simple and elegant way of doing it.
* Open source software, released under the MIT licence.
# Documentation
Extensive documentation for the bitstring module is available.
Some starting points are given below:
* [Overview](https://bitstring.readthedocs.io/en/stable/index.html)
* [Quick Reference](https://bitstring.readthedocs.io/en/stable/quick_reference.html)
* [Full Reference](https://bitstring.readthedocs.io/en/stable/reference.html)
There is also an introductory walkthrough notebook on [binder](https://mybinder.org/v2/gh/scott-griffiths/bitstring/main?labpath=doc%2Fwalkthrough.ipynb).
# Examples
### Installation
```
$ pip install bitstring
```
### Creation
```pycon
>>> from bitstring import Bits, BitArray, BitStream, pack
>>> a = BitArray(bin='00101')
>>> b = Bits(a_file_object)
>>> c = BitArray('0xff, 0b101, 0o65, uint6=22')
>>> d = pack('intle16, hex=a, 0b1', 100, a='0x34f')
>>> e = pack('<16h', *range(16))
```
### Different interpretations, slicing and concatenation
```pycon
>>> a = BitArray('0x3348')
>>> a.hex, a.bin, a.uint, a.float, a.bytes
('3348', '0011001101001000', 13128, 0.2275390625, b'3H')
>>> a[10:3:-1].bin
'0101100'
>>> '0b100' + 3*a
BitArray('0x866906690669, 0b000')
```
### Reading data sequentially
```pycon
>>> b = BitStream('0x160120f')
>>> b.read(12).hex
'160'
>>> b.pos = 0
>>> b.read('uint12')
352
>>> b.readlist('uint12, bin3')
[288, '111']
```
### Searching, inserting and deleting
```pycon
>>> c = BitArray('0b00010010010010001111') # c.hex == '0x1248f'
>>> c.find('0x48')
(8,)
>>> c.replace('0b001', '0xabc')
>>> c.insert('0b0000', pos=3)
>>> del c[12:16]
```
### Arrays of fixed-length formats
```pycon
>>> from bitstring import Array
>>> a = Array('uint7', [9, 100, 3, 1])
>>> a.data
BitArray('0x1390181')
>>> a[::2] *= 5
>>> a
Array('uint7', [45, 100, 15, 1])
```
<sub>Copyright (c) 2006 - 2024 Scott Griffiths</sub>
Raw data
{
"_id": null,
"home_page": null,
"name": "bitstring",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "binary, bitarray, bitvector, bitfield",
"author": null,
"author_email": "Scott Griffiths <dr.scottgriffiths@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/d0/d6f57409bb50f54fe2894ec5a50b5c04cb41aa814c3bdb8a7eeb4a0f7697/bitstring-4.2.3.tar.gz",
"platform": null,
"description": "\n\n![bitstring](https://raw.githubusercontent.com/scott-griffiths/bitstring/main/doc/bitstring_logo_small.png \"bitstring\")\n\n**bitstring** is a Python module to help make the creation and analysis of all types of bit-level binary data as simple and efficient as possible.\n\nIt has been actively maintained since 2006.\n\n\n\n[](https://github.com/scott-griffiths/bitstring/actions/workflows/ci.yml)\n[](https://bitstring.readthedocs.io/en/latest/)\n[](https://app.codacy.com/gh/scott-griffiths/bitstring/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n[](https://libraries.io/pypi/bitstring)\n \n[](https://www.pepy.tech/projects/bitstring)\n[](https://pypistats.org/packages/bitstring)\n\n----\n\n> [!NOTE]\n> To see what been added, improved or fixed, and also to see what's coming in the next version, see the [release notes](https://github.com/scott-griffiths/bitstring/blob/main/release_notes.md).\n\n\n# Overview\n\n* Efficiently store and manipulate binary data in idiomatic Python.\n* Create bitstrings from hex, octal, binary, files, formatted strings, bytes, integers and floats of different endiannesses.\n* Powerful binary packing and unpacking functions.\n* Bit-level slicing, joining, searching, replacing and more.\n* Create and manipulate arrays of fixed-length bitstrings.\n* Read from and interpret bitstrings as streams of binary data.\n* Rich API - chances are that whatever you want to do there's a simple and elegant way of doing it.\n* Open source software, released under the MIT licence.\n\n# Documentation\n\nExtensive documentation for the bitstring module is available.\nSome starting points are given below:\n\n* [Overview](https://bitstring.readthedocs.io/en/stable/index.html)\n* [Quick Reference](https://bitstring.readthedocs.io/en/stable/quick_reference.html)\n* [Full Reference](https://bitstring.readthedocs.io/en/stable/reference.html)\n\nThere is also an introductory walkthrough notebook on [binder](https://mybinder.org/v2/gh/scott-griffiths/bitstring/main?labpath=doc%2Fwalkthrough.ipynb).\n\n# Examples\n\n### Installation\n```\n$ pip install bitstring\n```\n\n### Creation\n```pycon\n>>> from bitstring import Bits, BitArray, BitStream, pack\n>>> a = BitArray(bin='00101')\n>>> b = Bits(a_file_object)\n>>> c = BitArray('0xff, 0b101, 0o65, uint6=22')\n>>> d = pack('intle16, hex=a, 0b1', 100, a='0x34f')\n>>> e = pack('<16h', *range(16))\n```\n\n### Different interpretations, slicing and concatenation\n```pycon\n>>> a = BitArray('0x3348')\n>>> a.hex, a.bin, a.uint, a.float, a.bytes\n('3348', '0011001101001000', 13128, 0.2275390625, b'3H')\n>>> a[10:3:-1].bin\n'0101100'\n>>> '0b100' + 3*a\nBitArray('0x866906690669, 0b000')\n```\n\n### Reading data sequentially\n```pycon\n>>> b = BitStream('0x160120f')\n>>> b.read(12).hex\n'160'\n>>> b.pos = 0\n>>> b.read('uint12')\n352\n>>> b.readlist('uint12, bin3')\n[288, '111']\n```\n\n### Searching, inserting and deleting\n```pycon\n>>> c = BitArray('0b00010010010010001111') # c.hex == '0x1248f'\n>>> c.find('0x48')\n(8,)\n>>> c.replace('0b001', '0xabc')\n>>> c.insert('0b0000', pos=3)\n>>> del c[12:16]\n```\n\n### Arrays of fixed-length formats\n```pycon\n>>> from bitstring import Array\n>>> a = Array('uint7', [9, 100, 3, 1])\n>>> a.data\nBitArray('0x1390181')\n>>> a[::2] *= 5\n>>> a\nArray('uint7', [45, 100, 15, 1])\n```\n\n\n<sub>Copyright (c) 2006 - 2024 Scott Griffiths</sub>\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple construction, analysis and modification of binary data.",
"version": "4.2.3",
"project_urls": {
"documentation": "https://bitstring.readthedocs.io/",
"homepage": "https://github.com/scott-griffiths/bitstring"
},
"split_keywords": [
"binary",
" bitarray",
" bitvector",
" bitfield"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "675b62278b308e45ba5edb4b6390a69033def7ade220890cafaaba9ef656a302",
"md5": "e0e98deff2c7a64b1d061a761a7c8860",
"sha256": "20ed0036e2fcf0323acb0f92f0b7b178516a080f3e91061470aa019ac4ede404"
},
"downloads": -1,
"filename": "bitstring-4.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0e98deff2c7a64b1d061a761a7c8860",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 71671,
"upload_time": "2024-05-25T21:08:01",
"upload_time_iso_8601": "2024-05-25T21:08:01.325081Z",
"url": "https://files.pythonhosted.org/packages/67/5b/62278b308e45ba5edb4b6390a69033def7ade220890cafaaba9ef656a302/bitstring-4.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8d0d6f57409bb50f54fe2894ec5a50b5c04cb41aa814c3bdb8a7eeb4a0f7697",
"md5": "5edecacd8fa0356601f7035977d0749e",
"sha256": "e0c447af3fda0d114f77b88c2d199f02f97ee7e957e6d719f40f41cf15fbb897"
},
"downloads": -1,
"filename": "bitstring-4.2.3.tar.gz",
"has_sig": false,
"md5_digest": "5edecacd8fa0356601f7035977d0749e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 250537,
"upload_time": "2024-05-25T21:08:03",
"upload_time_iso_8601": "2024-05-25T21:08:03.949102Z",
"url": "https://files.pythonhosted.org/packages/d8/d0/d6f57409bb50f54fe2894ec5a50b5c04cb41aa814c3bdb8a7eeb4a0f7697/bitstring-4.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-25 21:08:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scott-griffiths",
"github_project": "bitstring",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bitstring"
}
