EasyCsv.Files 1.0.5

EasyCsv Nuget

EasyCsv is a simple and efficient .NET library for handling CSV files in your projects. With a fluent user-friendly API, it allows you to easily read, write, and manipulate CSV files with a minimal amount of code.

Features

• Read and write CSV files
• Fluent API for method chaining
• Perform basic operations on CSV files, such as adding or removing columns, filtering rows, sorting data, and replacing values in a column
• Support for dependency injection

Installation

Install the EasyCsv package via NuGet:

NuGet\Install-Package EasyCsv

Usage

Add EasyCsv services to your .NET project

In your Startup.cs or in the class where you configure your services, add the following code to register EasyCsv services:

    public void ConfigureServices(IServiceCollection services)
    {
        services.AddEasyCsvFactories();
        // services.AddEasyCsvFactory();
        // services.AddEasyFileCsvFactory();
    }

Read a CSV file

The is automatically done when you use the IEasyCsvFactory or IEasyCsvFileFactory to create your ICsvService. To recalculate ContentBytes and ContentStr, call easyCsv.CalculateContent()

    [Inject] private IEasyCsvFileFactory EasyCsvFileFactory { get; set; }
    [Inject] private IEasyCsvFactory EasyCsvFactory { get; set; }
    
    =============================================================
    
    IBrowserFile file = files[0];
    var strCsv = "header1\nheader1value";
    var easyCsv = await EasyCsvFileFactory.FromIBrowserFileAsync(file);
    var easyCsv2 = await EasyCsvFactory.FromStringAsync();
    // You can access the ContentStr, ContentBytes, and create C# Objects using GetRecords<T> at this point

Manipulate CSV data

EasyCsv provides a set of methods for manipulating CSV data. Some examples include:

No matter what you manipulate, don't forget to call csvService.CalculateContent() after you are done doing your manipulations. csvService.CsvContent is the only content that is always up to date. ContentStr and ContentBytes are calculated when you create an IEasyCsv, after that they are only calculated when csvService.CalculateContent() is called.

Remove a column:

    var easyCsv = EasyCsvFactory.CreateFromBytes(fileContent)
    easyCsv.RemoveColumn("header2");

Add column with default value

    easyCsv.AddColumn("column name", "value given to all rows in column/header field", upsert: true);

Replace header row

You can replice all the headers in the header row of this CSV. The count of new header row must match count of the current CsvContent

    List<string> newHeaderRow = new () { "header1", "header2", "header3" }
    easyCsv.ReplaceHeaderRow(newHeaderRow);

Filter rows:

This would remove any row where the value of header1 is less than 10. Would throw an error if any value couldn't be converted to an int.

    easyCsv.FilterRows(row => (int)row["header1"] > 10);

Replace values in a column:

    var valueMapping = new Dictionary<object, object>
    {
        { "OldValue", "NewValue" }
    };
    easyCsv.ReplaceValuesInColumn("header1", valueMapping);

Sort data by column:

The easiest way is to sort by a column to give them in alphabetical order based on that column, but you can also provide a Func<IDictionary<string, object>, TKey>. to sort like this csvService.SortCsv(row => row["FieldName"].ToString().Length, ascending: false);. This would sort rows by the lengths of fields in column "FieldName"

    easyCsv.SortCsv("header1", ascending: true);

Read directly to objects

Do whatever operations you need to the csv, then read it directly into objects

    List<Person> people = easyCsv.GetRecordsAsync<Person>();

Chain Method Calls Fluently

    var newRow2Columns = new Dictionary<string, object>()
    {
        {"header1", "not header1 value"},
        {"header2", "header2 value"}
    };
    var newRow3Columns = new Dictionary<string, object>()
    {
        {"header1", "header1 value"},
        {"header2", "header2 value"},
        {"header3", "header3 value"}
    };
    easyCsv.InsertRow(newRow)
           .AddColumn("header3", "value given to all rows in header3 column")
           .InsertRow(newRow3Columns)
           .FilterRows(row => (string)row["header1"] != "header1 value") // Would remove newRow2Columns (Which would have 3 columns rights here because of AddColumn)
           .CalculateFileContent();

For more methods and usage examples, please refer to the EasyCsv documentation and source code.

Contributing I gladly welcome contributions to EasyCsv! If you find a bug or have a feature request, please open an issue on the project's GitHub repository. If you would like to contribute code, please submit a pull request.

License EasyCsv is licensed under the MIT License.