semvec/pypi-packages huggingface dataset:
csv-reader 2.0.0a0
reader library for csv files.
License: Apache 2.0

# 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:
```python
from csv_reader import Reader
```

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

## Documentation
<br>
Visit https://csv-reader.readthedocs.io/en/latest for the documentation.
<br>
<br>

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

### Reader

#### openWithName()

```python
with Reader.openWithName("test.csv") as file:
    for line in file:
        print(line)
```
<br>
note: when used in a `for` loop, each `line` is a list of values in each line of the file.

#### openWithFile()
``` python
with Reader.openWithFile(open("test.csv" newline="")) as file:
    for line in file:
        print(line)
```
<br>
note: when used in a `for` loop, each `line` is a list of values in each line of the file.

#### readFromName()

```python
with Reader.readFromName("test.csv") as file:
    for line in file:
        print(line)
```
<br>
note: `line` is a string.

#### readFromFile()

```python
with Reader.readFromFile(open("test.csv", newline="")) as file:
    for line in file:
        print(line)
```
<br>
note: `line` is a string.

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

```python
from csv_reader import Writer
```
<br>

#### csv_reader.CSVWriter
```python
with CSVWriter("test.csv") as file:
    file.write(["test1", "test2"])
```
<br>

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