isda-streaming 1.1.1

A light-weight streaming library for the ISDA course at TU Berlin.

ISDA Streaming

isda_streaming is a minimal library intended to learn working with data streams.

The implementation is highly simplified and adapted to the requirements of the course "Informationssysteme und Datenanalyse" at TU Berlin. Therefore, it should not be taken as a reference to implement a complete data streams management system.

The documentation for isda_streaming is work in progress. If you notice any errors or inconsistencies, please report them in the course forum or as an issue in this repository.

Installation

You can clone and install this repository:

git clone https://git.tu-berlin.de/dima/isda/isda-streaming
cd isda-streaming
pip install .

Or perform all steps in one command:

pip install git+https://git.tu-berlin.de/dima/isda/isda-streaming

Usage

See the documentation for detailed instructions. In general, all public classes are importable from the top-level isda_streaming module:

from isda_streaming import DataStream

ds = DataStream().from_csv("/path/to/collection.csv")

Contributing

If you want to contribute a bug fix or feature to isda_streaming, please open an issue first to ensure that your intended contribution fits into the project.

Different to a user installation, you also need to install the dev requirements and activate pre-commit in your copy of the repository before making a commit.

# Activate your virtual environment first
pip install ".[dev]"
pre-commit install