41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# URL-safe Base64 for Python
|
|
|
|
A simple module for encoding without padding, fixing Python standard library's flaws.
|
|
|
|
Replaces the standard library's `base64.urlsafe_b64encode` and `base64.urlsafe_b64decode` with a cleaner implementation that returns strings instead of bytes and avoids unnecessary padding.
|
|
|
|
## Features
|
|
|
|
- **URL safe**: Uses only characters that are safe for URLs and filenames
|
|
- **No padding**: Removes trailing `=` characters for cleaner output
|
|
- **String output**: Returns proper strings instead of bytes (unlike Python's standard library)
|
|
- **Fast**: Based on Python stdlib, with constant-time padding restoration
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
pip install b64url
|
|
```
|
|
|
|
Or for your project using [uv](https://docs.astral.sh/uv/):
|
|
```sh
|
|
uv add b64url
|
|
```
|
|
|
|
## Usage
|
|
|
|
```python
|
|
import b64url
|
|
|
|
text = b64url.enc(bytes(4)) # Returns str "AAAAAA"
|
|
data = b64url.dec(text) # Returns the original bytes
|
|
```
|
|
|
|
### `enc(data: bytes) -> str`
|
|
|
|
Encode bytes to a web-safe Base64 string without padding.
|
|
|
|
### `dec(s: str) -> bytes`
|
|
|
|
Decode a web-safe Base64 string to bytes. Padding is optional.
|