TinyCsvParser

by bytefish

bytefish / TinyCsvParser

Easy to use, easy to extend and high-performance library for CSV parsing with .NET

218 Stars 55 Forks Last release: over 1 year ago (2.5.2) MIT License 220 Commits 11 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

TinyCsvParser

TinyCsvParser is a .NET library to parse CSV data in an easy and fun way, while offering very high performance and a very clean API. It is highly configurable to provide maximum flexibility.

To get started quickly, follow the Quickstart.

TinyCsvParser supports .NET Core.

Installing TinyCsvParser

You can use NuGet to install TinyCsvParser. Run the following command in the Package Manager Console.

PM> Install-Package TinyCsvParser

Documentation and Changelog

TinyCsvParser comes with an official documentation and changelog:

Basic Usage

This is only an example for the most common use of TinyCsvParser. For more detailed information on custom formats and more advanced use-cases, please consult the full User Guide of the official documentation.

Imagine we have list of Persons in a CSV file

persons.csv
with their first name, last name and birthdate.
FirstName;LastName;BirthDate
Philipp;Wagner;1986/05/12
Max;Musterman;2014/01/02

The corresponding domain model in our system might look like this.

private class Person
{
    public string FirstName { get; set; }

public string LastName { get; set; }

public DateTime BirthDate { get; set; }

}

When using TinyCsvParser you have to define the mapping between the columns in the CSV data and the property in you domain model.

private class CsvPersonMapping : CsvMapping
{
    public CsvPersonMapping()
        : base()
    {
        MapProperty(0, x => x.FirstName);
        MapProperty(1, x => x.LastName);
        MapProperty(2, x => x.BirthDate);
    }
}

And then we can use the mapping to parse the CSV data with a

CsvParser
.
namespace TinyCsvParser.Test
{
    [TestFixture]
    public class TinyCsvParserTest
    {
        [Test]
        public void TinyCsvTest()
        {
            CsvParserOptions csvParserOptions = new CsvParserOptions(true, ';');
            CsvPersonMapping csvMapper = new CsvPersonMapping();
            CsvParser csvParser = new CsvParser(csvParserOptions, csvMapper);

        var result = csvParser
            .ReadFromFile(@"persons.csv", Encoding.ASCII)
            .ToList();

        Assert.AreEqual(2, result.Count);

        Assert.IsTrue(result.All(x => x.IsValid));

        Assert.AreEqual("Philipp", result[0].Result.FirstName);
        Assert.AreEqual("Wagner", result[0].Result.LastName);

        Assert.AreEqual(1986, result[0].Result.BirthDate.Year);
        Assert.AreEqual(5, result[0].Result.BirthDate.Month);
        Assert.AreEqual(12, result[0].Result.BirthDate.Day);

        Assert.AreEqual("Max", result[1].Result.FirstName);
        Assert.AreEqual("Mustermann", result[1].Result.LastName);

        Assert.AreEqual(2014, result[1].Result.BirthDate.Year);
        Assert.AreEqual(1, result[1].Result.BirthDate.Month);
        Assert.AreEqual(1, result[1].Result.BirthDate.Day);
    }
}

}

License

The library is released under terms of the MIT License:

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.