status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
YAML implementation for Nim https://nimyaml.org
326 Commits 6 Branches 28 Tags 2.3 MiB
Nim 98.7%
Nix 1.3%
Go to file
Felix Krause fd05f828ad Updated serialization doc 2016-10-20 18:12:35 +02:00
bench Fixed a GC problem; improved bench & tojson 2016-09-30 19:35:43 +02:00
doc Updated serialization doc 2016-10-20 18:12:35 +02:00
private More improvements to lexer 2016-09-30 20:12:17 +02:00
server Made server.nim compile against Nim 0.15.0 2016-10-01 14:49:32 +02:00
test Load objects with transient fields 2016-10-19 22:04:46 +02:00
yaml Load objects with transient fields 2016-10-19 22:04:46 +02:00
.gitignore Added automatic test for quickstart snippets 2016-10-08 23:35:33 +02:00
.travis.yml Separated test suites for travis 2016-10-09 16:10:11 +02:00
CHANGELOG.md Updated for 0.7.0 release 2016-10-01 14:55:44 +02:00
README.md Integrated parser and quickstart tests 2016-10-09 15:05:18 +02:00
config.nims Separated test suites for travis 2016-10-09 16:10:11 +02:00
copying.txt Added copyright 2015-12-28 22:22:51 +01:00
nimdoc.cfg got rid of yaml.common 2016-09-22 13:28:24 +02:00
yaml.nim doc link fixes 2016-10-01 15:19:42 +02:00
yaml.nimble Updated for 0.7.0 release 2016-10-01 14:55:44 +02:00

README.md

NimYAML - YAML implementation for Nim

Build Status

NimYAML is a pure Nim YAML implementation without any dependencies other than Nim's standard library. It enables you to serialize Nim objects to a YAML stream and back. It also provides a low-level event-based API, and a document object model which you do not want to use because serializing to native types is much more awesome.

Documentation, examples and an online demo are available here. Releases are available as tags in this repository and can be fetched via nimble:

nimble install yaml

Features that may come in the future

  • Serialization:
    • Support for more standard library types
    • Support for polymorphism
    • Support for generic objects
    • Support for transient fields (i.e. object fields that will not be (de-)serialized

Developers

nim tests # runs all tests
nim lexerTests # run lexer tests
nim parserTests # run parser tests (git-clones yaml-dev-kit)
nim serializationTests # runs serialization tests
nim quickstartTests # run tests for quickstart snippets from documentation
nim documentation # builds documentation to folder docout
nim server # builds the REST server used for the testing ground
nim bench # runs benchmarks, requires libyaml
nim clean # guess
nim build # build a library

NimYAML needs at least Nim 0.15.0 in order to compile.

License

MIT