csv-reader 2.0.0a0

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 csv_reader import Reader

in your code:

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

Documentation

Visit https://csv-reader.readthedocs.io/en/latest for the documentation.

Examples

The examples can also be found at https://csv-reader.readthedocs.io/en/latest/Examples.html

Reader

openWithName()

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()

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()

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

note: `line` is a string.

readFromFile()

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

note: `line` is a string.

Writer

The Writer module provides 2 classes for writing to csv files. 1 uses lists while another uses dicts.

from csv_reader import Writer

csv_reader.CSVWriter

with CSVWriter("test.csv") as file:
    file.write(["test1", "test2"])

csv_reader.CSVDictWriter

with CSVDictWriter("test.csv", ["field1", "field2"]) as file:
    file.writeRows([
        {"field1":"test1", "field2":"test2"},
        {"field1": "test3", "field2": "test4"}
    ])