fsprojects/FSharp.Data

FSharp.Data: Making Data Access Simple

The FSharp.Data package (FSharp.Data.dll) implements everything you need to access data in your F# applications and scripts. It implements F# type providers for working with structured file formats (CSV, HTML, JSON and XML) and for accessing the WorldBank data. It also includes helpers for parsing CSV, HTML and JSON files and for sending HTTP requests.

The library supports both sample-based and schema-based type inference. The XML Type Provider supports XSD schemas, and the JSON Type Provider now supports JSON Schema for defining structured, strongly-typed access to JSON documents.

We're open to contributions from anyone. If you want to help out but don't know where to start, you can take one of the Up-For-Grabs issues, or help to improve the documentation.

You can see the version history here.

Building

• Install the .NET SDK specified in the global.json file
• build.sh -t Build or build.cmd -t Build

Formatting

dotnet run --project build/build.fsproj -t Format
dotnet run --project build/build.fsproj -t CheckFormat

Documentation

This library comes with comprehensive documentation. The documentation is automatically generated from *.fsx files in the content folder and from the comments in the code. If you find a typo, please submit a pull request!

• FSharp.Data package home page with more information about the library, contributions, etc.
• The samples from the documentation are included as part of FSharp.Data.Tests.sln, make sure you build the solution before trying out the samples to ensure that all needed packages are installed.

Releasing

Releasing of the NuGet package is done by GitHub actions CI from the main branch when a new version is pushed.

Releasing of docs is done by GitHub actions CI on each push to the main branch.

Support and community

• If you have a question about FSharp.Data, ask at StackOverflow and mark your question with the f#-data tag.
• If you want to submit a bug, a feature request or help with fixing bugs then look at issues and read contributing to FSharp.Data.
• To discuss more general issues about FSharp.Data, its goals and other open-source F# projects, join the fsharp-opensource mailing list

Code of Conduct

This repository is governed by the Contributor Covenant Code of Conduct.

We pledge to be overt in our openness, welcoming all people to contribute, and pledging in return to value them as whole human beings and to foster an atmosphere of kindness, cooperation, and understanding.

Library license

The library is available under Apache 2.0. For more information see the License file in the GitHub repository.

Repo Assist

This repository uses Repo Assist, an AI assistant that helps triage issues, guide contributors, make progress and propose fixes. It may not be active if workflow permissions have expired.

Maintainers

Current maintainers are Don Syme and Phillip Carter

Historical maintainers of this project are Gustavo Guerra, Tomas Petricek and Colin Bull.