csv-reader 1.2.0

reader library for csv files.

Introduction

Welcome to my small python project. This library just provides some functions to read from csv files. I developed this library for fun. If anyone wants to contribute, feel free to contact me or open an issue. This library uses the built-in csv module

Installation

Type this into your command prompt: pip install csv-reader

Usage

at the top of your py files:

from reader import Reader

in your code:

with Reader.openWithName("test.csv") as file:
    for line in file:
        print(line)

Documentation

openWithName(name: str)

opens a file with the given file name and returns a context manager.
name - the name of the csv file.
throws: FileNotFoundError - when the file could not be found. e.g.

with Reader.openWithName("test.csv") as file:
    for line in file:
        print(line)

note: when used in a `for` loop, each `line` is a list of values in each line of the file.

openWithFile(file: TextIO)

returns a context manager from an already opened file.
file - the file object.
throws: FileNotFoundError - when the file could not be found. e.g.

with Reader.openWithFile(open("test.csv" newline="")) as file:
    for line in file:
        print(line)

note: when used in a `for` loop, each `line` is a list of values in each line of the file.

readFromName(name: str)

opens a file with given name and returns a context manager that yields an iterator that yields each line in the file.
name - the name of the csv file.
throws: FileNotFoundError - when the file could not be found. e.g.

with Reader.readFromName("test.csv") as file:
    for line in file:
        print(line)

note: `line` is a string.

readFromFile(file: TextIO)

returns an context manager from an already opened file that yields an iterator that yields each line in the file.
file - the file object.
throws: FileNotFoundError - when the file could not be found. e.g.

with Reader.readFromFile(open("test.csv", newline="")) as file:
    for line in file:
        print(line)

note: `line` is a string.