Skip to main content

No project description provided

Project description

Latest Version Supported Python Versions Documentation Status

This project is designed to develop a class, base64io.Base64IO, that implements a streaming interface for Base64 encoding.

Python has supported native Base64 encoding since version 2.4. However, there is no streaming interface for Base64 encoding, and none is available from the community.

The legacy base64.encode and base64.decode interface lets you shuffle data between two streams, but it assumes that you have two complete streams. We wanted a standard stream that applies Base64 encoding and decoding.

base64io.Base64IO provides an io streaming interface with context manager support that transparently Base64-encodes data read from it. You can use it to transform large files without caching the entire context in memory, or to transform an existing stream.

For the latest full documentation, see Read the Docs.

Find us on GitHub.

Getting Started

base64io.Base64IO has no dependencies other than the standard library and should work with any version of Python greater than 2.6. We test it on CPython 2.6, 2.7, 3.3, 3.4, 3.5, 3.6, and 3.7.

Installation

$ pip install base64io

Use

base64io.Base64IO wraps the input stream and transparently encodes or decodes data written to or read from the input stream.

  • write() encodes data before writing it to the wrapped stream

  • read() decodes data after reading it from the wrapped stream

Because the position of the base64io.Base64IO stream and the wrapped stream will almost always be different, base64io.Base64IO does not support:

  • seek()

  • tell()

Also, base64io.Base64IO does not support:

  • fileno()

  • truncate()

Encode data

from base64io import Base64IO

with open('source_file', 'rb') as source, open('encoded_file', 'wb') as target:
   with Base64IO(target) as encoded_target:
      for line in source:
         encoded_target.write(line)

Decode data

from base64io import Base64IO

with open('encoded_file', 'rb') as encoded_source, open('target_file', 'wb') as target:
   with Base64IO(encoded_source) as source:
      for line in source:
         target.write(line)

License

This library is licensed under the Apache 2.0 License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

base64io-1.0.0.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

base64io-1.0.0-py2.py3-none-any.whl (16.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file base64io-1.0.0.tar.gz.

File metadata

  • Download URL: base64io-1.0.0.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for base64io-1.0.0.tar.gz
Algorithm Hash digest
SHA256 aac3ba723cba2e949ff74abd3edbca5aa3bf5cc35c62eedd9d2a085480229990
MD5 52d3feda8a9439f3714cca5a3c71fc47
BLAKE2b-256 f4996f59219832e2e0c7edccf82fafef2300fb8b1f9a4a70594819ae74b13b07

See more details on using hashes here.

File details

Details for the file base64io-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for base64io-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 676016ca53a7475cb8888bcd113b38a49d77651bc766619f54782341dbfb83d1
MD5 c6f5dbcf7d79bb21a82f223792b64c16
BLAKE2b-256 991409b8d9bd8c254ba1595815c5d2c11951f4aee9dd6bf34e2e9a7ad2710084

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page