Skip to content

Latest commit

 

History

History
217 lines (174 loc) · 9.84 KB

README.md

File metadata and controls

217 lines (174 loc) · 9.84 KB
Raw

NuGet

EasyCsv

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
  • Support for larger number of types: byte[], string, Stream, TextReader, Objects, IBrowserFile, IFormFile
  • Fluent API for method chaining
  • Mutations context to limit error proneability
  • 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

Blazor Components

Documentation

Example Website

Installation

Install the EasyCsv package via NuGet:

NuGet\Install-Package EasyCsv -Version 2.0.0-beta8.2

Usage

Creating an IEasyCsv and reading a CSV file

The reading of the csv is automatically done when you use the EasyCsvFactory or EasyCsvFileFactory to create your IEasyCsv. It is also automatically done when you call easyCsv.Mutate() or easyCsv.MutateAsync() unless you set the saveChanges flag to false. WARNING. All From(Type) methods will return null if something goes wrong or the csv contains 0 rows.

IBrowserFile file = files[0];
var strCsv = "header1,header2\nheader1value,header2value";
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 an assortment of methods for manipulating CSV data. All calls that manipulate the CSV are done through easyCsv.Manipulate(Action<CSVMuationScope> scope) or easyCsv.ManipulateAsync(Action<CSVMuationScope> scope). The scope will ensure that the ContentStr and ContentBytes are up to date after you do manipulations.

Add/Insert column with default value

easyCsv.Mutate(mutation =>
{
    mutation.AddColumn("column name", "value given to all rows in column/header field", upsert: true);
    mutation.InsertColumn(index: 2, "different col name", "val");
});

Remove a column:

var easyCsv = await EasyCsvFactory.FromStreamAsync(fileStream);
easyCsv.Mutate(mutation => mutation.RemoveColumn("header2"));

Replace Columns

Removes the column of the old header field and upserts all it's values to all the rows of the new header field. CSV

easyCsv.Mutate(mutation => mutation.ReplaceColumn(string oldHeaderField, string newHeaderField));

Swap Columns

Swaps the position of columns in a csv. The values follow the columns through swap.

// Csv Original Headers: "col1,col2,col3,col4"
easyCsv.Mutate(mutation =>
{
    mutation.SwapColumns("col1", "col4"); // By column name
    // Headers are now: "col4,col2,col3,col1"

    mutation.SwapColumns(1, 2); // By column index
    // Headers are now: "col4,col3,col2,col1"
});

Move Column

Moves a column to a new index. The values follow the column through swap. All other columns are shifted right or left accordingly.

// Csv Original Headers: "col1,col2,col3,col4"
easyCsv.Mutate(mutation =>
{
    mutation.MoveColumn("col4", 0); // Moves "col4" to index 0
    // Headers are now: "col4,col1,col2,col3"

    mutation.MoveColumn(3, 0); // Moves the column at index 3 (col3) to index 0
    // Headers are now: "col3,col4,col1,col2"
});

Replace header row

You can replace all the headers in the header row of this CSV. The number of headers in the new row must match the number of headers current CsvContent or no operation will be performed

List<string> newHeaderRow = new () { "newHeader1", "newHeader2", "newHeader3" }
easyCsv.Mutate(mutation => mutation.ReplaceHeaderRow(newHeaderRow));

Remove unused data

Removes any header that does match a public property on the type param T.

// Removes all fields that don't match public property on Person
await easyCsv.MutateAsync(mutation => await mutation.RemoveUnusedHeadersAsync<Person>(caseInsensitive:true));

Filter rows:

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

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

Map values in a column:

// before "header1,header2\nOldValue,OldValue";
var valueMapping = new Dictionary<object, object>
{
    { "OldValue", "NewValue" }
};
easyCsv.Mutate(mutation => mutation.MapValuesInColumn("header1", valueMapping));
// after "header1,header2\nNewValue,OldValue";

Sort data by column:

You can provide a Func<IDictionary<string, object>, TKey>. to sort like this easyCsv.SortCsv(row => row["FieldName"].ToString().Length, ascending: false);. This would sort rows by the lengths of fields in column "header1"

easyCsv.Mutate(mutation => mutation.SortCsv("header1", ascending: true));

Combine CSVs

Some care will need to be taken with this since the headers must match exactly, however it is perfect to use when you know you have two csvs that were read an object of type T.

var easyCsv1 = EasyCsvFactory.FromObjects<Person>(people1);
var easyCsv2 = EasyCsvFactory.FromObjects<Person>(people2);
var combinedCsv = easyCsv1.Combine(easyCsv2); 
// The configurations from easyCsv1 will used in the combinedCsv
// This can also be done in the mutation context

Read directly to objects

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

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

Crud Operations

I also have some CRUD operations for directly working with rows. UpdateRow, UpsertRow, DeleteRow, AddRow, etc

Convenience methods

I include plenty of convenience methods on EasyCsv such as Clone(), ColumnNames(), GetRowCount(), ContainsHeader(), Clear()

Chain Method Calls Fluently

// before  header1,header2, header3
//          value1,value2, value3
//          value1,value2, value3
easyCsv.Mutate(mutations => mutations.RemoveColumn("header2")
                                     .AddColumn("header4", "value4")
                                     .ReplaceColumn("header1", "newHeader1"));
       
// after  newHeader1, header3, header4
//          value1, value3, value4
//          value1, value3, value4

Operate on individual rows

This code shows how you can add a "Name" column to a csv and populate it with values based on the Id column in the csv.

In the example, the Id column is the first column in the csv. This inserts a name column after the Id column.

Note: When operating on individual rows, it is your job to ensure that column structure is maintained in each row. Without the else statement, there would be a chance that some rows are missing a column called "Name" leading to undefined behaviour. Something you can do is call InsertColumn or AddColumn before adding an optional value to all rows which will ensure that each row at least has the column. Note-2: Expect all values to be string. The only times that isn't true is if you add a column with a default value other than a string.

Dictionary<long, string> idToNameDict = GetCustomerNames();
// Before "Id,Company,Position"
await csv.MutateAsync(x =>
{
    x.InsertColumn(1, "Name");
    foreach (var row in x.CsvContent)
    {
        if (row["Id"] is string str && long.TryParse(str, out var num) && idToNameDict.TryGetValue(num, out string name))
        {
            row["Name"] = name;
        }
        else
        {
            row["Name"] = "Unknown";
        }
    }
});
// After "Id,Name,Company,Position"

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.

Acknowledgements

This library makes use of the following third-party dependencies:

CsvHelper

EasyCsv uses CsvHelper to read and write CSV files. CsvHelper is licensed under the Microsoft Public License (Ms-PL). We would like to thank the authors and contributors of CsvHelper for their work on this excellent library.

License Information

Please note the following licensing terms for EasyCsv's packages:

  • General License: All packages are licensed under the MIT License, except for the code located in the EasyCsv.Components folder.
  • Special Licensing for EasyCsv.Components: The code within the EasyCsv.Components folder is licensed under the AGPL-3.0 License.

Usage Guidelines:

  1. Internal Use: If the EasyCsv.Components package is solely used within your company by company employees for internal operations, and not exposed to external customers, you may utilize these components under the MIT License. This allows your team to integrate and use these components internally without the broader requirements of the AGPL-3.0 License. Please still include the AGPL-3.0 License in your project if you use a clone.

  2. External Use: Any deployment of the EasyCsv.Components in a customer facing application or service, for-profit or not, is strictly governed by the AGPL-3.0 License. This includes any form of service provided over a network where the components are used to interact with users. In such scenarios, you must comply with all provisions of the AGPL-3.0 License, including but not limited to making the source code available to all users.

Known Issues and Limitations

License EasyCsv is licensed under the MIT License.