Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aaubry/YamlDotNet
YamlDotNet is a .NET library for YAML
https://github.com/aaubry/YamlDotNet
dotnet parser serialization yaml
Last synced: 3 months ago
JSON representation
YamlDotNet is a .NET library for YAML
- Host: GitHub
- URL: https://github.com/aaubry/YamlDotNet
- Owner: aaubry
- License: mit
- Created: 2012-10-11T21:43:57.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T17:18:01.000Z (4 months ago)
- Last Synced: 2024-10-14T22:41:14.974Z (3 months ago)
- Topics: dotnet, parser, serialization, yaml
- Language: C#
- Size: 8.31 MB
- Stars: 2,547
- Watchers: 62
- Forks: 480
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-libyaml
Awesome Lists containing this project
- stars - aaubry/YamlDotNet
- awesome - aaubry/YamlDotNet - YamlDotNet is a .NET library for YAML (C\#)
- awesome - YamlDotNet - YamlDotNet is a .NET library for YAML (C# #)
README
# YamlDotNet
| Appveyor | NuGet |
|----------|-------|
|[](https://ci.appveyor.com/project/aaubry/yamldotnet/branch/master)| [](https://www.nuget.org/packages/YamlDotNet/)
YamlDotNet is a YAML library for [netstandard and other .NET runtimes](#the-yamldotnet-library).
YamlDotNet provides low level parsing and emitting of YAML as well as a high level object model similar to XmlDocument. A serialization library is also included that allows to read and write objects from and to YAML streams.
YamlDotNet's conformance with YAML specifications:
| YAML Spec | YDN Parser | YDN Emitter |
|:-----------------------------------:|:----------:|:-----------:|
| [v1.1](https://yaml.org/spec/1.1/) | ✓ | ✓ |
| [v1.2](https://yaml.org/spec/1.2/spec.html) | ✓ | |
## What is YAML?
YAML, which stands for "YAML Ain't Markup Language", is described as "a human friendly data serialization standard for all programming languages". Like XML, it allows to represent about any kind of data in a portable, platform-independent format. Unlike XML, it is "human friendly", which means that it is easy for a human to read or produce a valid YAML document.
## The YamlDotNet library
The library has now been successfully used in multiple projects and is considered fairly stable. It is compatible with the following runtimes:
* netstandard 2.0
* netstandard 2.1
* .NET 6.0
* .NET 8.0
* .NET Framework 4.7
## Quick start
Here are some quick samples to get you started which can be viewed in [this fiddle](https://dotnetfiddle.net/CQ7ZKi).
### Serialization from an object to a string
```c#
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
...
var person = new Person
{
Name = "Abe Lincoln",
Age = 25,
HeightInInches = 6f + 4f / 12f,
Addresses = new Dictionary{
{ "home", new Address() {
Street = "2720 Sundown Lane",
City = "Kentucketsville",
State = "Calousiyorkida",
Zip = "99978",
}},
{ "work", new Address() {
Street = "1600 Pennsylvania Avenue NW",
City = "Washington",
State = "District of Columbia",
Zip = "20500",
}},
}
};
var serializer = new SerializerBuilder()
.WithNamingConvention(CamelCaseNamingConvention.Instance)
.Build();
var yaml = serializer.Serialize(person);
System.Console.WriteLine(yaml);
// Output:
// name: Abe Lincoln
// age: 25
// heightInInches: 6.3333334922790527
// addresses:
// home:
// street: 2720 Sundown Lane
// city: Kentucketsville
// state: Calousiyorkida
// zip: 99978
// work:
// street: 1600 Pennsylvania Avenue NW
// city: Washington
// state: District of Columbia
// zip: 20500
```
### Deserialization from a string to an object
```c#
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
...
var yml = @"
name: George Washington
age: 89
height_in_inches: 5.75
addresses:
home:
street: 400 Mockingbird Lane
city: Louaryland
state: Hawidaho
zip: 99970
";
var deserializer = new DeserializerBuilder()
.WithNamingConvention(UnderscoredNamingConvention.Instance) // see height_in_inches in sample yml
.Build();
//yml contains a string containing your YAML
var p = deserializer.Deserialize(yml);
var h = p.Addresses["home"];
System.Console.WriteLine($"{p.Name} is {p.Age} years old and lives at {h.Street} in {h.City}, {h.State}.");
// Output:
// George Washington is 89 years old and lives at 400 Mockingbird Lane in Louaryland, Hawidaho.
```
## More information
More information can be found in the [project's wiki](https://github.com/aaubry/YamlDotNet/wiki).
## Installing
Just install the [YamlDotNet NuGet package](http://www.nuget.org/packages/YamlDotNet/):
```
PM> Install-Package YamlDotNet
```
If you do not want to use NuGet, you can [download binaries here](https://ci.appveyor.com/project/aaubry/yamldotnet).
YamlDotNet is also available on the [Unity Asset Store](https://assetstore.unity.com/packages/tools/integration/yamldotnet-for-unity-36292).
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## Release notes
Please see the Releases at https://github.com/aaubry/YamlDotNet/releases
## Sponsorships
A big shout out to all of our sponsors
[](https://www.github.com/aws)