Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ionite34/base2048
Binary encoding with base-2048 in Python with Rust
https://github.com/ionite34/base2048
base-encoding base2048 encoding pyo3 python rust unicode
Last synced: about 2 months ago
JSON representation
Binary encoding with base-2048 in Python with Rust
- Host: GitHub
- URL: https://github.com/ionite34/base2048
- Owner: ionite34
- License: mit
- Created: 2022-09-17T17:16:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T21:57:02.000Z (2 months ago)
- Last Synced: 2024-10-22T17:48:46.804Z (2 months ago)
- Topics: base-encoding, base2048, encoding, pyo3, python, rust, unicode
- Language: Rust
- Homepage:
- Size: 121 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Base 2048 [![pypi_badge]][pypi_url] [![versions]][pypi_url]
[build_badge]: https://github.com/ionite34/base2048/actions/workflows/build.yml/badge.svg
[build_url]: https://github.com/ionite34/base2048/actions/workflows/build.yml
[versions]: https://img.shields.io/pypi/pyversions/base2048
[pypi_badge]: https://badge.fury.io/py/base2048.svg
[pypi_url]: https://pypi.org/project/base2048/
[twitter_count]: https://developer.twitter.com/en/docs/basics/counting-characters
[rs_base]: https://github.com/LLFourn/rust-base2048
[bmp]: https://unicode.org/roadmaps/bmp/
[rtl]: https://wikipedia.org/wiki/Right-to-left_mark
[![build_badge]][build_url]
[](https://github.com/ionite34/base2048/actions/workflows/rust-test.yml)
[](https://github.com/ionite34/base2048/actions/workflows/py-test.yml)
[](https://codecov.io/gh/ionite34/base2048)
[](https://results.pre-commit.ci/latest/github/ionite34/base2048/main)
### When Base 64 is not enough
Allows up to 11 bits of data per unicode character as counted by
social media and chat platforms such as [Twitter][twitter_count] and Discord.
Uses a limited charset within the [Basic Multilingual Plane][bmp].
Based on, and uses a compatible encoding table with the Rust crate [rust-base2048][rs_base].
### - Charset displayable on most locales and platforms
### - No control sequences, punctuation, quotes, or [RTL][rtl] characters
## Getting Started
```shell
pip install base2048
```
```python
import base2048
base2048.encode(b'Hello!')
# => 'ϓțƘ໐µ'
base2048.decode('ϓțƘ໐µ')
# => b'Hello!'
```
### Up to 2x less counted characters compared to Base 64
```python
import zlib
import base64
import base2048
string = ('🐍 🦀' * 1000 + '🐕' * 1000).encode()
data = zlib.compress(string)
b64_data = base64.b64encode(data)
# => b'eJztxrEJACAQBLBVHNUFBBvr75zvRvgxBEkRSGqvkbozIiIiIiIiIiIiIiIiIiIiIiJf5wAAAABvNbM+EOk='
len(b64_data)
# => 84
b2048_data = base2048.encode(data)
# => 'ը྿Ԧҩ২ŀΏਬйཬΙāಽႩԷ࿋ႬॴŒǔ०яχσǑňॷβǑňॷβǑňॷβǯၰØØÀձӿօĴ༎'
len(b2048_data)
# => 46
unpacked = zlib.decompress(base2048.decode(b2048_data)).decode()
len(unpacked)
# => 4000
unpacked[2000:2002]
# => '🦀🐍'
```
### Decode errors are provided with a character-position of failure
```python
----> base2048.decode('༗ǥԢΝĒϧǰ༎ǥ')
DecodeError: Unexpected character 8: ['ǥ'] after termination sequence 7: ['༎']
```
- To catch the error, use either `base2048.DecodeError` or its base exception, `ValueError`.
```python
import base2048
try:
base2048.decode('🤔')
except base2048.DecodeError as e:
print(e)
```
## License
The code in this project is released under the [MIT License](LICENSE).
## Related and prior works
> Javascript - [base2048](https://github.com/qntm/base2048)
> Rust - [rust-base2048][rs_base]