Skip to main content

Streamly is a very simple yet powerful wrapper for streams (file-like objects). It is primarily designed to help with the cleaning up of flat data during on the fly read operations.

A typical use case that is especially prevalent within digital marketing, is wanting to download/upload a web stream to some target location that expects clean, flat delimited data but the stream includes unwanted header and footer data. Developers often deal with this by loading the data as-is into an interim location and then opening the file and culling the unwanted leading and trailing lines. This approach works but limitations include: not easily reproducible; increases the complexity of the solution; assumes a storage component; inefficient with large data sets.

Streamly solves this problem by handling the unwanted headers and footers on the fly in a highly efficient manner.

Documentation: https://streamly.readthedocs.io

Installation

Requires Python 3.1+

With pipenv

Install:

pipenv install streamly

OR Update:

pipenv update streamly

With pip

Install & Update:

pip install streamly --upgrade

Example Usage

The below example writes a byte stream to a file, removing the unwanted header and footer details on the fly.

import io

import streamly


my_stream = io.BytesIO(
b"""Header
Metadata
Unwanted
=
Garabage

Report Fields:
col1,col2,col3,col4,col5
data,that,we,actually,want
and,potentially,loads,of,it,
foo,bar,baz,lorem,ipsum
foo,bar,baz,lorem,ipsum
foo,bar,baz,lorem,ipsum
...,...,...,...,...
Grand Total:,0,0,1000,0
More
Footer
Garbage
"""
)

wrapped_stream = streamly.Streamly(my_stream, header_row_identifier=b"Report Fields:\n",
                                   footer_identifier=b"Grand")

data = wrapped_stream.read(50)
while data:
    print(data)
    data = wrapped_stream.read(50)

Features

Includes the following functionality during on the fly read operations:

  • Adjoining of multiple streams

  • Removal of header and footer data, identified by a value (e.g. byte string or string)

  • Logging of read progress

  • Guaranteed read size (where the data is not yet exhausted)

  • Consistent API for streams returning byte strings or strings

Release files for Streamly 0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Streamly 0.3
File Size Uploaded
Streamly-0.3.tar.gz 6.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for Streamly 0.3
File Interpreter ABI Platform
Streamly-0.3-py3-none-any.whl Python 3 none any Details

Total release size: 13.1 kB

Release files / Streamly-0.3.tar.gz

Download URL Streamly-0.3.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ddaa8540ae074682b8f60b62b6a9ddf1c7889b10d87c2ad9a629a8527f4a3874
BLAKE2b-256 checksum
How to use checksums
99c49029250e22e70a8c75e253bace1f590e1922549874069645e0abf977b63d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / Streamly-0.3-py3-none-any.whl

Download URL Streamly-0.3-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88e5614539c82ea3cbfab583910d8c28cbef89557a05073c42147a80ddea3d07
BLAKE2b-256 checksum
How to use checksums
0d6068ab984271e702e78c3f0ec48127be2443191f3e3c84f1b074ee4b27d138
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page